1rancid.types.conf(5)          File Formats Manual         rancid.types.conf(5)
2
3
4

NAME

6       rancid.types.conf - rancid device type configuration file
7

DESCRIPTION

9       rancid.types.conf  contains  formatted  configuration lines that define
10       the device types that are available for use in the <device_type>  field
11       of the router.db(5) configuration file.
12
13       The  rancid.types.base  configuration file follows the same format, but
14       defines the base types described in router.db(5).
15
16       Users are STRONGLY discouraged from altering this  file  or  overriding
17       the base types in rancid.types.conf.  Instead, copy the type definition
18       to be altered  from  rancid.types.base  to  rancid.types.conf  using  a
19       different <device_type>.
20

SYNTAX

22       One directive is listed per-line, where the syntax is one of:
23
24                 <device_type>;alias;<alternate_device_type>
25                 <device_type>;command;<filter_function>;<device_command_string>
26                 <device_type>;inloop;<input_loop_function>
27                 <device_type>;login;<login_program>
28                 <device_type>;module;<perl_module_name>
29                 <device_type>;prescript;<rancid_script> XXX temporary knob?  add this?
30                 <device_type>;postscript;<rancid_script> XXX temporary knob?  add this?
31                 <device_type>;script;<rancid_script>
32                 <device_type>;timeout;<login_program_timeout>
33
34       For example:
35                 cisco;login;clogin
36                 cisco;timeout;120
37                 cisco;module;rancid::ios
38                 cisco;inloop;ios::inloop
39                 cisco;command;ShowVersion;show version
40                 juniper;login;/usr/local/bin/jlogin
41                 juniper;module;rancid::junos
42                 juniper;inloop;junos::inloop
43                 juniper;command;ShowVersion;show version
44                 srx;alias;juniper
45
46       <device_type>  is a lower case name used in the router.db(5) file.  Its
47       case is forced to lower case when reading the configuration files.
48
49       Each <device_type> may have  the  following  directives  defined.   The
50       login and script directives are required, unless it is an alias.
51
52       alias  Defines  an alias for another <device_type>, it does NOT augment
53              it.  The <device_type> target may be defined  in  either  device
54              type configuration file.
55
56       command
57              Defines  commands  to run for the <device_type> and the function
58              that will process the input.
59
60       inloop Intended for rancid(1), inloop defines a function to  loop  over
61              the  input  from the device.  It must have the calling signature
62              f($INPUT, $OUTPUT).
63
64       login  Defines the login script used for the <device_type>, which  does
65              not need to be an FQPN, but then must be found in the path.
66
67       module Loads  a  rancid  perl  module  to  supply functions used in the
68              command directives for the <device_type>.  Multiple module lines
69              may  exist  for a device type, they are loaded in the order they
70              appear.
71
72       script Defines the rancid script used for the <device_type>, which does
73              not  need  to be an FQPN, but then must be found in the process'
74              path.
75
76       timeout
77              Defines the rancid login script timeout in seconds.  In general,
78              the default 90 seconds, but some modules themselves alter this.
79

FILES

81       /etc/rancid/rancid.types.conf
82              Configuration file described here.
83
84       /etc/rancid/rancid.types.base
85              Configuration file described here.
86

SEE ALSO

88       control_rancid(1), rancid(1), rancid-run(1), router.db(5), rancid(3)
89
90
91
92                                 24 March 2020            rancid.types.conf(5)
Impressum