NAME

MakeRancidConf - Generate RANCID Configuration

INTRODUCTION

This worker will generate a RANCID configuration for all devices in Netdisco.

Optionally you can provide configuration to control the output, however the defaults are sane, and will create one RANCID group called "default" which contains all devices. Those devices not discovered successfully within the past day will be marked as "down" for RANCID to skip. Configuration is saved to the "rancid" subdirectory of Netdisco's home folder.

You could run this worker at 09:05 each day using the following configuration:

 schedule:
   makerancidconf:
     when: '5 9 * * *'

CONFIGURATION

Here is a complete example of the configuration, which must be called "rancid". All keys are optional:

 rancid:
   rancid_home:  "$ENV{NETDISCO_HOME}/rancid" # default
   down_age:     '1 day'                      # default
   delimiter:    ':'                          # default
   groups:
     groupname1: 'host_group1_acl'
     groupname2: 'host_group2_acl'
   vendormap:
     vname1:     'host_group3_acl'
     vname2:     'host_group4_acl'
   by_ip:        'host_group5_acl'
   by_hostname:  'host_group6_acl'

Note that the default home for writing files is not "/var/lib/rancid" so you may wish to set this (especially if migrating from the old netdisco-rancid-export script).

Any values above that are a Host Group ACL will take either a single item or list of Network Identifiers or Device Properties. See the ACL documentation wiki page for full details. We advise you to use the "host_groups" setting and then refer to named entries in that, for example:

 host_groups:
   coredevices: '192.0.2.0/24'
   edgedevices: '172.16.0.0/16'
 
 rancid:
   groups:
     core_devices: 'group:coredevices'
     edge_devices: 'group:edgedevices'

rancid_home

The location to write RANCID Group configuration files into. A subdirectory for each Group will be created.

down_age

This should be the same or greater than the interval between regular discover jobs on your network. Devices which have not been discovered within this time will be marked as "down" to RANCID.

The format is any time interval known and understood by PostgreSQL, such as at https://www.postgresql.org/docs/8.4/static/functions-datetime.html.

delimiter

Set this to the delimiter character if needed to be different from the default.

groups

This dictionary maps RANCID Group names with configuration which will match devices in the Netdisco database.

The left hand side (key) should be the RANCID group name, the right hand side (value) should be a Netdisco ACL to select devices in the Netdisco database.

vendormap

If the device Vendor in Netdisco is not the same as the RANCID vendor script, configure a mapping here.

The left hand side (key) should be the RANCID vendor, the right hand side (value) should be a Netdisco ACL to select devices in the Netdisco database.

by_ip

Netdisco ACL to select devices which will be written to the RANCID config as an IP address, instead of the DNS FQDN or SNMP host name.

by_hostname

Netdisco ACL to select devices which will have the unqualified host name written to the RANCID config. This is done simply by stripping the domain_suffix configuration setting from the device FQDN.

SEE ALSO

1 POD Error

The following errors were encountered while parsing the POD:

Around line 98:

Non-ASCII character seen before =encoding in '# default'. Assuming UTF-8