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 brancid Bay Networks (nortel)
36 cat5rancid Cisco catalyst switches
38 cssrancid Cisco content services switches
40 erancid ADC-kentrox EZ-T3 mux
42 f5rancid F5 BigIPs
44 rancid The generic rancid script; supporting Allied Telesis AW+
46 devices, Arbor Networks Appliances, Arista EOS, Ciena
47 Waverserver, Cisco IOS, Cisco IOS-XR, Cisco NX-OS, Cisco
48 WLC, (some) Dell switches, Extreme switches, Fortinet
49 firewalls, Force10 (aka Dell NOS9), Foundry (aka some
50 Brocade) devices, Juniper JunOS and JunOS EVO, Nokia
51 (Alcatel-Lucent) SR OS, and UBNT Edgemax and EdgeRouter,
52 and SMC (some Dell switches). It uses the device O/S
53 modules for parsing routines as determined by the
54 rancid.types.conf(5) file(s). Also see rancid(3) for
55 details.
56 hrancid HP Procurve Switches
58 htranicd Hitachi Routers
60 jerancid Juniper Networks E-series
62 mrancid MRTd
64 mtrancid Mikrotik routers
66 nrancid Netscreen firewalls
68 nsrancid Netscaler
70 rivrancid Riverstone
72 rrancid Redback
74 trancid Netopia sDSL/T1 routers
76 xirancid Xirrus arrays
78 zrancid Zebra routing software
80 If rancid is run for a device type whose script, as defined in
82 rancid.types.base or rancid.types.conf, is not rancid, then that script
83 will be exec(2)'d.
84 The command-line options are as follows:
86 -C Prints the login command that would be used to collect data from
88 the device.
89 -V Prints package name and version strings.
91 -d Display debugging information.
93 -h Display a usage line and exit.
95 -l Display somewhat less debugging information.
97 -t Device type, of the given host or file, that is defined in
99 rancid.types.base or rancid.types.conf .
100 -f rancid should interpret the next argument as a filename which
102 contains the output it would normally collect from the device (
103 hostname) with clogin(1).
104
106 control_rancid(1), clogin(1), rancid.conf(5), rancid.types.conf(5),
107 rancid(3)
108
110 Cisco IOS offers a DHCP server that maintains a text database which can
111 be stored remotely or on local storage. If stored locally, the file
112 changes constantly and causes constant diffs from rancid. If this
113 file's name ('ip dhcp database') matches the regex
114 dhcp_[^[:space:].].txt, it will be filtered. For Catalyst switches
115 running CatOS, type cat5, the prompt must end with '>'. clogin(1)
116 looks for '>' to determine when a login is successful. For example:
117 cat5k>
119 cat5k> enable
120 Password:
121 cat5k> (enable)
122 rancid works on Cisco Catalyst 1900 series switches that are running
124 Enterprise Edition software. This software provides a menu at
125 connection time that allows a command line interface to be used by
126 entering 'K' at the prompt.
127 19 November 2019 rancid(1)