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

FILES

74       /etc/rancid/rancid.types.conf
75              Configuration file described here.
76
77       /etc/rancid/rancid.types.base
78              Configuration file described here.
79

SEE ALSO

81       control_rancid(1), rancid(1), rancid-run(1), router.db(5), rancid(3)
82
83
84
85                                 18 July 2017             rancid.types.conf(5)
Impressum