Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
router.db(5)		       File Formats Manual		    router.db(5)

NAME
     router.db - rancid group configuration file

DESCRIPTION
     router.db	contains  information  for devices which are members of a rancid
     group.  control_rancid(1) reads this file to  compile  a  list  of  devices
     which it should collect.

SYNTAX
     One device is listed per-line, where the syntax is:

	       <device_name>;<device_type>;<state>[;comments]

     For example:
	       scooby.shrubbery.net;cisco;up

     The fields are as follows:

     <device_name>
	    The  name  of the device, which must resolve via gethostbyname, used
	    as the argument to telnet(1), rsh(1), or ssh(1), to connect  to  the
	    device.  Once converted to lower-case, this also becomes the name of
	    the     file    used    to	  store    the	  configuration    under
	    $BASEDIR/<group>/configs.

	    Experience has shown that using the device's FQDN  (Fully  Qualified
	    Domain Name) works best, as in the example above.

     <device_type>
	    The type of device from the set:

	     agm    A  Cisco Anomaly Guard Module (aka Riverhead).  Suspect that
		    at some point the UI will become more cisco-like and it  can
		    be merged with the IOS rancid module.

	     alteon
		    An Alteon WebOS switches.

	     arcos  An Arrcus router.

	     arista
		    An Arista Networks device.

	     baynet
		    A Bay Networks router.

	     bigip  A F5 device running BIG-IP >= v11.

	     cat5   A  Cisco  catalyst	series	5000  and  4000  switches (i.e.:
		    running the catalyst OS, not IOS).

	     ciena-ws
		    A Ciena Waveserver.

	     cisco  A Cisco router, PIX, or switch such as the	3500XL	or  6000
		    running IOS (or IOS-like) OS, but not IOS-XR, NX-OS or Cisco
		    small business devices.

	     cisco-sb
		    A Cisco small business devices.

	     cisco-nx
		    A Cisco Nexus switch/router.

	     cisco-xr
		    A Cisco device running IOS-XR.

	     cisco-wlc4
		    A Cisco Wireless Controller versions up to 4.

	     cisco-wlc5
		    A Cisco Wireless Controller versions 5 and above.

	     css    A Cisco content services switch.

	     enterasys
		    An	enterasys  NAS.   This	is  currently  an  alias for the
		    riverstone device type.

	     erx    A Juniper E-series edge router.

	     fss2   A Fujitsu FSS2/1finity device.

	     dell   A  Dell  switch.   Known  working  models	are   DES-3010F,
		    DES-3052P, DES-3526, and DES-3550.	Note that Dell OEMs some
		    equipment  and  has  purchased  some  companies,  so  a Dell
		    product may not work with the dell	rancid	module	but  may
		    work with smc or force10.

	     extreme
		    An Extreme switch.

	     ezt3   An ADC-Kentrox EZ-T3 mux.

	     f5     A F5 BigIP switch.

	     force10
		    A Force10 router.

	     fortigate
		    A Fortinet firewall.

	     fortigate-full
		    A Fortinet firewall with all defaults shown.

	     foundry
		    A  Foundry	router, switch, or router-switch.  This includes
		    HP Procurve switches that are OEMs of Foundry products, such
		    as the HP9304M.

	     hitachi
		    A Hitachi router.

	     hp     A HP Procurve switch such as the 2524, 4108 or J9086A  (aka.
		    2610)  procurve  switches, J9091A, and J8698A.  Also see the
		    foundry type.

	     juniper
		    A Juniper router.

	     mrtd   A host running the (Merit) MRTd daemon.

	     mrv    A MRV  optical  device;  including	NC316,	OptiSwitch  904,
		    OptiSwitch 906G, OptiSwitch 912C, OptiSwitch 940.

	     netscaler
		    A Netscaler load balancer.

	     netscreen
		    A Netscreen firewall.

	     paloalto
		    A Palo Alto Networks device.

	     redback
		    A Redback router, NAS, etc.

	     riverstone
		    A Riverstone NAS or Cabletron (starting with version ~9.0.3)
		    router.

	     routeros
		    A Mikrotik RouterOS router.

	     smc    A  SMC  switch,  which  also  account  for	some  Dell OEMs.
		    Including Dell PowerConnect 35xx (3524, 3524P, 3548,  3548P)
		    and 7048.

	     sros   A Nokia (Alcatel-Lucent) router, such as the 7750 SR.

	     xirrus
		    A Xirrus array.

	     zebra  Zebra routing software.

     <state>
	    The  state	is  either  "up",  or  some  other arbitrary value, e.g.
	    "down".  If the device is not marked "up" the device's configuration
	    will not be collected.  It is highly recommended that  comments  are
	    made for any router not listed as up, so as to indicate the reason a
	    router is not to be polled, e.g.:

	    dial1.paris;cisco;up;
	    core1.paris;cisco;down;in testing until 5/5/2001.
	    core2.paris;cisco;ticketed;Ticket 6054234, 5/3/2001
	    border1.paris;juniper;up;

	    The  script "downreport" in util/ can be used to produce a report of
	    routers in router.db that are not marked "up".

     [comments]
	    Freeform string to describe the current state of the router.

     A ``#'' at the beginning of a  line  is  a  comment;  the	entire	line  is
     ignored.

     If  a  device is deleted from the router.db file, then rancid will clean up
     by removing the device's config file  from  $BASEDIR/<group>/configs.   The
     device  will  be removed from the revision control system.  It is possible,
     in  most  cases,  to  resurrect  or  check-out  copies  of  deleted  device
     configurations.

FILES
     $BASEDIR/<group>/router.db
	    Configuration  file  described here, where <group> is a device group
	    name    defined    in    the    variable	LIST_OF_GROUPS	  within
	    $BASEDIR/etc/rancid.conf.

SEE ALSO
     control_rancid(1), rancid(1), rancid.conf(5)

HISTORY
     In  RANCID  releases  prior  to 3.0, router.db used colons (:) as its field
     separator.  This was  changed  to	allow  IPv6  addresses	to  be	used  in
     router.db.

				   5 May 2020			    router.db(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=router.db&sektion=5&manpath=FreeBSD+Ports+15.1.quarterly>

home | help