f5rancid (1) - Linux Man Pages
f5rancid: Cisco configuration filter
NAMErancid - Cisco configuration filter
SYNOPSISrancid [-dlCV] [-t device_type] (-f filename | hostname)
DESCRIPTIONrancid is a collection of perl(1) scripts which uses the login scripts (see clogin(1)) to login to a device, execute commands to display the configuration, etc, then filters the output for formatting, security, and so on. rancid's product is a file with the name of it's last argument plus the suffix .new. For example, hostname.new.
rancid is also a perl(1) script that operates much like rancid, but is generic and will eventually obsolete the rancid script. It uses the device_type specified with the -t option to look-up a device description that defines what it does to collect and process device information.
There are scripts complementary to rancid for other platforms and/or manufacturers that are supported by rancid(1). Briefly, these are:
- Cisco Anomaly Guard Module (AGM)
- Alteon WebOS switches
- Arista Networks devices
- Bay Networks (nortel)
- Cisco catalyst switches
- Cisco content services switches
- ADC-kentrox EZ-T3 mux
- F5 BigIPs
- Fortinet Firewalls
- The generic rancid script; supporting Allied Telesis AW+ devices, Arbor Networks Appliances, Cisco IOS, Cisco IOS-XR, Cisco WLC, Dell switches, Compass EOS, and Juniper JUNOS. It uses the device O/S modules for parsing routines. See rancid(3) for details.
- HP Procurve Switches
- Hitachi Routers
- Juniper Networks E-series
- Juniper Networks
- Mikrotik routesrs
- Netscreen firewalls
- Cisco Nexus boxes
- Procket Networks
- SMC switch (some Dell OEMs)
- Netopia sDSL/T1 routers
- Lucent TNT
- Xirrus arrays
- Extreme switches
- Cisco IOS-XR boxes
- Zebra routing software
The command-line options are as follows:
- Prints the login command that would be used to collect data from the device.
- Prints package name and version strings.
- Display debugging information.
- Display a usage line and exit.
- Display somewhat less debugging information.
- Device type, of the given host or file, that is defined in rancid.types.base or rancid.types.conf .
- rancid should interpret the next argument as a filename which contains the output it would normally collect from the device ( hostname) with clogin(1).
CAVEATSCisco IOS offers a DHCP server that maintains a text database which can be stored remotely or on local storage. If stored locally, the file changes constantly and causes constant diffs from rancid. If this file's name ('ip dhcp database') matches the regex dhcp_[^[:space:].].txt, it will be filtered.
For Catalyst switches running CatOS, type cat5, the prompt must end with '>'. clogin(1) looks for '>' to determine when a login is successful. For example:
cat5k> cat5k> enable Password: cat5k> (enable)
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.