netdisco-rancid-export - Generate RANCID Group Configuration
Note! This script is now deprecated and no longer maintained. The replacement is built in to Netdisco core, so can be scheduled in the backend, and also has more powerful configuration. See App::Netdisco::Worker::Plugin::MakeRancidConf.
This script requires some configuration to be added to your Netdisco "~/environments/deployment.yml" file, for example:
~/environments/deployment.yml
rancid: rancid_home: /var/lib/rancid down_age: '1 day' delimiter: ':' by_ip: [ other ] by_hostname: [ other2 ] groups: switch: [ 'name:.*[Ss][Ww].*' ] rtr: [ 'name:[rR]tr.*' ] ap: [ 'name:[aA][pP].*' ] vendormap: "dell": force10 "dell:2024": dellnseries
Note that netdisco-rancid-export is not part of the automatic scheduler built in to Netdisco. You should run this script via cron just after your periodic discoverall.
netdisco-rancid-export
cron
discoverall
rancid_home
The location to write RANCID Group configuration files into. A subdirectory for each Group will be created.
Default: "/var/lib/rancid".
/var/lib/rancid
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.
down
Default: "1 day".
1 day
delimiter
RANCID version 3 uses a semicolon as delimiter. Set this to the delimiter character if needed to be different from the default.
Default: ":".
:
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 Netdisco vendor, the right hand side (value) should be the RANCID vendor script name. You can also set the Netdisco vendor to be "vendor:model" for fine-grained control. See the synopsis for an example.
vendor:model
groups
This dictionary maps RANCID Group names with configuration which will match devices in the Netdisco database. The configuration is the same as any of Netdisco's "*_only" settings, and accepts IP, prefix, device property.
*_only
by_ip
List of RANCID Groups which will have Device IPs written to the RANCID configuration file, instead of DNS or SNMP host names.
by_hostname
List of RANCID Groups which will have Device Hostname written to the RANCID configuration file, instead of FQDN. This is done simply by stripping the domain_suffix configuration item from the FQDN.
domain_suffix
App::Netdisco
To install App::Netdisco, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Netdisco
CPAN shell
perl -MCPAN -e shell install App::Netdisco
For more information on module installation, please visit the detailed CPAN module installation guide.