#! /usr/bin/perl
##
## $Id: nixrancid.in,v 1.4 2008/01/21 10:43:25 lvermilion Exp $
##
#
# TODO
# * Add to personal rancid distribution.
# * OS Detection (maybe use variable to support user defined OS)
# * Collection of more system critical files
# * Fix netstat to not include Use/Expire fields on BSD
#
# Changelog
#
# v1.4 lvermilion 1-21-08
# Added support so the original F5 script works on Linux/BSD/Unix
# Added support for the command "sudo su root"
# Added BSDConfFile, since these files are BSD specific
# and we don't want them ran unless we are on a BSD system
# Added a variety of linux/BSD commands
# Removed F5 commands at this point until OS detection is completed.
#
# v1.3 lvermilion
# Add banner formatting so it is more clear what command was ran
# Add support for more F5 commands (profile/monitor/regkey/license/etc).
#
# v1.2 mashcraft 9-18-07
# Fixed invalid TERM causing intermitent failures
# Works as non-root user
# Added Platform info and static routes
#
# v1.1 mashcraft 8-2-07
# Debugging problems with HF8.
#
#
## Copyright (C) 1997-2004 by Terrapin Communications, Inc.
## All rights reserved.
##
## Copyright (C) 2007 by Omniture, Inc. Ver 1.1-1.2
## All rights reserved.
##
## Copyright (C) 2008 by Gheek.net Ver 1.3-1.4
## All rights reserved.
##
## This software may be freely copied, modified and redistributed
## without fee for non-commerical purposes provided that this license
## remains intact and unmodified with any RANCID distribution.
##
## There is no warranty or other guarantee of fitness of this software.
## It is provided solely "as is". The author(s) disclaim(s) all
## responsibility and liability with respect to this software's usage
## or its effect upon hardware, computer systems, other software, or
## anything else.
##
## Except where noted otherwise, rancid was written by and is maintained by
## Henry Kilmer, John Heasley, Andrew Partan, Pete Whiting, and Austin Schutz.
##
#
# Based on rancid, this script handles F5 BigIP/(Li|U)nix,BSD systems.
# Modifications by Mike Ashcraft and Lance Vermilion.
#
# This script has been tested with Big-IP Version 9.1.2, 9.2.x and 9.3.1
#
# This script uses nixlogin. You will need to configure the
# host in .cloginrc as follows:
#
# add user hostname username
# add userprompt hostname sshOnlyNoPrompt # The default prompt regex matches the last login message and causes problems
# add method hostname ssh
# add password hostname password
# add autoenable hostname 1
#
# RANCID - Really Awesome New Cisco confIg Differ
#
# usage: nixrancid [-d] [-l] [-f filename | $host]
#
use Getopt::Std;
getopts('dfl');
$log = $opt_l;
$debug = $opt_d;
$file = $opt_f;
$host = $ARGV[0];
$clean_run = 0;
$found_end = 0;
$found_version = 0;
$found_env = 0;
$found_diag = 0;
$timeo = 90; # clogin timeout in seconds
my(@commandtable, %commands, @commands);# command lists
my(%filter_pwds); # password filtering mode
# This routine is used to print out the router configuration
sub ProcessHistory {
my($new_hist_tag,$new_command,$command_string,@string) = (@_);
if ((($new_hist_tag ne $hist_tag) || ($new_command ne $command))
&& defined %history) {
print eval "$command \%history";
undef %history;
}
if (($new_hist_tag) && ($new_command) && ($command_string)) {
if ($history{$command_string}) {
$history{$command_string} = "$history{$command_string}@string";
} else {
$history{$command_string} = "@string";
}
} elsif (($new_hist_tag) && ($new_command)) {
$history{++$#history} = "@string";
} else {
print "@string";
}
$hist_tag = $new_hist_tag;
$command = $new_command;
1;
}
sub numerically { $a $b; }
# This is a sort routine that will sort numerically on the
# keys of a hash as if it were a normal array.
sub keynsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort numerically keys(%lines)) {
$sorted_lines[$i] = $lines{$key};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# keys of a hash as if it were a normal array.
sub keysort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort keys(%lines)) {
$sorted_lines[$i] = $lines{$key};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# values of a hash as if it were a normal array.
sub valsort{
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $key (sort values %lines) {
$sorted_lines[$i] = $key;
$i++;
}
@sorted_lines;
}
# This is a numerical sort routine (ascending).
sub numsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $num (sort {$a $b} keys %lines) {
$sorted_lines[$i] = $lines{$num};
$i++;
}
@sorted_lines;
}
# This is a sort routine that will sort on the
# ip address when the ip address is anywhere in
# the strings.
sub ipsort {
local(%lines) = @_;
local($i) = 0;
local(@sorted_lines);
foreach $addr (sort sortbyipaddr keys %lines) {
$sorted_lines[$i] = $lines{$addr};
$i++;
}
@sorted_lines;
}
# These two routines will sort based upon IP addresses
sub ipaddrval {
my(@a) = ($_[0] =~ m#^(\d+)\.(\d+)\.(\d+)\.(\d+)$#);
$a[3] + 256 * ($a[2] + 256 * ($a[1] +256 * $a[0]));
}
sub sortbyipaddr {
&ipaddrval($a) &ipaddrval($b);
}
# sub Platform 31-Jan-2007 Mike Ashcraft mashcraft@omniture.com
# This routine parses "cat filename"
sub Platform {
print STDERR " In Platform: $_" if ($debug);
ProcessHistory("COMMENTS","","BO","\n!+----------------------------------------------+\n!|\n!| #### Running $cmd\n!|\n!+----------------------------------------------+\n");
while () {
tr/15//d;
last if (/^$prompt/);
next if (/degC/);
ProcessHistory("","","$cmd","$_");
}
$found_end = 1;
return(0);
}
# sub BSDConfFile 21-Jan-2008 Lance Vermilion lvermilion@gheek.net
# This routine parses "cat filename"
sub BSDConfFile {
print STDERR " In BSDConfFile: $_" if ($debug);
$uname=`uname`;
ProcessHistory("COMMENTS","","BO","\n!+----------------------------------------------+\n!|\n!| #### Running $cmd\n!|\n!+----------------------------------------------+\n") if ( $uname !~ /BSD/i );
while () {
last if ( $uname !~ /BSD/i );
tr/15//d;
last if (/^$prompt/);
ProcessHistory("","","$cmd","$_") if ( $uname =~ /BSD/i );
}
$found_end = 1;
return(0);
}
# sub ConfFile 31-Jan-2007 Mike Ashcraft mashcraft@omniture.com
# This routine parses "cat filename"
sub ConfFile {
print STDERR " In ConfFile: $_" if ($debug);
ProcessHistory("COMMENTS","","BO","!+----------------------------------------------+\n!|\n!| #### Running $cmd\n!|\n!+----------------------------------------------+\n");
while () {
tr/15//d;
last if (/^$prompt/);
if ( $cmd =~ /netstat/ )
{
next if /.*UHLW.*/
}
next if ($cmd =~ /config sync show/ && !/^\s+Status/);
ProcessHistory("","","$cmd","$_");
}
$found_end = 1;
return(0);
}
# sub DirList 31-Jan-2007 Mike Ashcraft mashcraft@omniture.com
# This routine parses directory listings.
#
# Disable color and make sure the date format is consistent
# For example: ll --time-style=long-iso --color=never
#
sub DirList {
print STDERR " In ConfFile: $_" if ($debug);
ProcessHistory("COMMENTS","","BO","!+----------------------------------------------+\n!|\n!| #### Running $cmd\n!|\n!+----------------------------------------------+\n");
while () {
tr/15//d;
last if (/^$prompt/);
ProcessHistory("","","$cmd","$_");
}
$found_end = 1;
return(0);
}
# sub NoOutput 18-Sep-2007 Mike Ashcraft mashcraft@omniture.com
# This routine handles commands where you do not want any output
#
#
sub NoOutput {
print STDERR " In ConfFile: $_" if ($debug);
while () {
tr/15//d;
last if (/^$prompt/);
}
$found_end = 1;
return(0);
}
# dummy function
sub DoNothing {print STDOUT;}
# Main
@commandtable = (
{'TERM=xterm' => 'NoOutput'},
{'export TERM' => 'NoOutput'},
{'uname -a' => 'Platform'},
{'netstat -rn' => 'ConfFile'},
{'cat /etc/passwd' => 'ConfFile'},
{'cat /etc/group' => 'ConfFile'},
{'cat /etc/hosts' => 'ConfFile'},
{'cat /etc/resolv.conf' => 'ConfFile'},
{'cat /etc/my.cnf' => 'ConfFile'},
{'cat /etc/drbd.conf' => 'ConfFile'},
{'cat /etc/fstab' => 'ConfFile'},
{'cat /etc/rc.conf' => 'ConfFile'},
{'cat /etc/iscsi/iscsid.conf' => 'ConfFile'},
{'cat /etc/modprobe.conf' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-bond0' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-bond1' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth0' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth1' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth2' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth3' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth4' => 'ConfFile'},
{'cat /etc/sysconfig/network-scripts/ifcfg-eth5' => 'ConfFile'},
{'alternatives --config java' => 'ConfFile'},
{'/sbin/chkconfig --list' => 'ConfFile'},
{'/usr/bin/yum list installed' => 'ConfFile'},
# {'bigpipe platform' => 'Platform'},
# {'bigpipe version' => 'ConfFile'},
# {'bigpipe list' => 'ConfFile'},
# {'bigpipe base list' => 'ConfFile'},
# {'bigpipe profile list' => 'ConfFile'},
# {'bigpipe monitor list' => 'ConfFile'},
# {'bigpipe config sync show' => 'ConfFile'},
# {'cat /config/RegKey.license' => 'ConfFile'},
# {'bigpipe route static show' => 'ConfFile'},
# {'ls --full-time --color=never /config/ssl/ssl.crt' => 'DirList'},
# {'ls --full-time --color=never /config/ssl/ssl.key' => 'DirList'},
);
# Use an array to preserve the order of the commands and a hash for mapping
# commands to the subroutine and track commands that have been completed.
@commands = map(keys(%$_), @commandtable);
%commands = map(%$_, @commandtable);
$cisco_cmds=join(";",@commands);
$cmds_regexp=join("|",@commands);
open(OUTPUT,">$host.new") || die "Can't open $host.new for writing: $!\n";
select(OUTPUT);
# make OUTPUT unbuffered if debugging
if ($debug) { $| = 1; }
if ($file) {
print STDERR "opening file $host\n" if ($debug);
print STDOUT "opening file $host\n" if ($log);
open(INPUT,"<$host") || die "open failed for $host: $!\n";
} else {
print STDERR "executing nixlogin -t $timeo -c\"$cisco_cmds\" $host\n" if ($debug);
print STDOUT "executing nixlogin -t $timeo -c\"$cisco_cmds\" $host\n" if ($log);
if (defined($ENV{NOPIPE})) {
system "nixlogin -t $timeo -c \"$cisco_cmds\" $host $host.raw 2>&1" || die "nixlogin failed for $host: $!\n";
open(INPUT, "< $host.raw") || die "nixlogin failed for $host: $!\n";
} else {
open(INPUT,"nixlogin -t $timeo -c \"$cisco_cmds\" $host </dev/null |") || die "nixlogin failed for $host: $!\n";
}
}
# determine password filtering mode
if ($ENV{"FILTER_PWDS"} =~ /no/i) {
$filter_pwds = 0;
} elsif ($ENV{"FILTER_PWDS"} =~ /all/i) {
$filter_pwds = 2;
} else {
$filter_pwds = 1;
}
ProcessHistory("","","","!RANCID-CONTENT-TYPE: nix\n!\n");
ProcessHistory("COMMENTS","keysort","B0","!\n");
ProcessHistory("COMMENTS","keysort","D0","!\n");
ProcessHistory("COMMENTS","keysort","F0","!\n");
ProcessHistory("COMMENTS","keysort","G0","!\n");
TOP: while() {
tr/15//d;
if (/\s?logout$/) {
$clean_run=1;
last;
}
if (/^Error:/) {
print STDOUT ("$host nixlogin error: $_");
print STDERR ("$host nixlogin error: $_") if ($debug);
$clean_run=0;
last;
}
while (/#\s*($cmds_regexp)\s*$/) {
$cmd = $1;
if (!defined($prompt)) {
$prompt = ($_ =~ /^([^#]+#)/)[0];
$prompt =~ s/([][}{)(\\])/\\$1/g;
print STDERR ("PROMPT MATCH: $prompt\n") if ($debug);
}
print STDERR ("HIT COMMAND:$_") if ($debug);
if (! defined($commands{$cmd})) {
print STDERR "$host: found unexpected command - \"$cmd\"\n";
$clean_run = 0;
last TOP;
}
$rval = };
delete($commands{$cmd});
if ($rval == -1) {
$clean_run = 0;
last TOP;
}
}
}
print STDOUT "Done $logincmd: $_\n" if ($log);
# Flush History
ProcessHistory("","","","");
# Cleanup
close(INPUT);
close(OUTPUT);
if (defined($ENV{NOPIPE})) {
unlink("$host.raw") if (! $debug);
}
# check for completeness
if (scalar(%commands) || !$clean_run || !$found_end) {
if (scalar(%commands)) {
printf(STDOUT "$host: missed cmd(s): %s\n", join(',', keys(%commands)));
printf(STDERR "$host: missed cmd(s): %s\n", join(',', keys(%commands))) if ($debug);
}
if (!$clean_run || !$found_end) {
print STDOUT "$host: End of run not found\n";
print STDERR "$host: End of run not found\n" if ($debug);
system("/usr/bin/tail -1 $host.new");
}
unlink "$host.new" if (! $debug);
}