File Coverage

blib/lib/Cisco/CopyConfig.pm

Criterion	Covered	Total	%
statement	28	89	31.4
branch	4	34	11.7
condition	1	14	7.1
subroutine	7	20	35.0
pod	4	14	28.5
total	44	171	25.7

#!/usr/bin/perl -w
###
### $Id: CopyConfig.pm,v 1.3 2004/11/04 22:23:19 aaronsca Exp aaronsca $
###
### -- Manipulate running-config of devices running IOS
###

package Cisco::CopyConfig;
use strict;
use Socket;
use Net::SNMP;
$Cisco::CopyConfig::VERSION = sprintf "%d.%02d", q$Revision: 1.3 $ =~ /(\d+)/g;

sub new {
###
### -- Create a new CopyConfig object

  my($class)	= shift;				## - Object class
  my($self)	= bless {
    'err'	=> '',					## - Error message
    'host'	=> '',					## - Default host
    'comm'	=> '',					## - Default community
    'tmout'	=> 2,					## - Default timeout
    'retry'	=> 2					## - Default retries
  }, $class;
  $self->_newarg(@_);					## - Parse arguments
  srand(time() ^ ($$ + ($$ << 15)));			## - Seed random number
  $self->{'snmp'} = $self->open();			## - Get SNMP object
  $self;
}

sub open {
###
### -- Create SNMP session and return object

  my($self)	= shift;

  $self->_newarg(@_);					## - Parse arguments
  unless(defined($self->{'host'}) && defined($self->{'comm'})){
    $self->{'err'} = 'missing hostname or community string';
    return undef;
  }
  $self->{'snmp'} = Net::SNMP->session(			## - Create SNMP object
    Hostname	=> $self->{'host'},
    Community	=> $self->{'comm'},
    Timeout	=> $self->{'tmout'},
    Retries	=> $self->{'retry'},
    Version	=> 1
  );
}

sub close {
###
### -- Shut down SNMP session and destroy SNMP object

  my($self)	= shift;
  my($status)	= $self->{'snmp'}->close();

  $self->{'snmp'} = undef;
  $status;
}

sub copy {
###
### -- Copy a running-config to a tftp server file

  my($self)	= shift;
  my($addr)	= shift || return undef;
  my($file)	= shift || return undef;

  unless($self->_cktftp($addr, $file)){
    return undef;
  }
  $self->{'rand'} = int(rand(1 << 24));
  $self->_xfer(
    $self->ccCopyProtocol(1),
    $self->ccCopySourceFileType(4),
    $self->ccCopyDestFileType(1),
    $self->ccCopyServerAddress($addr),
    $self->ccCopyFileName($file),
    $self->ccCopyEntryRowStatus(4)
  );
}

sub merge {
###
### -- Merge a tftp server file into a running-config

  my($self)	= shift;
  my($addr)	= shift || return undef;
  my($file)	= shift || return undef;

  unless($self->_cktftp($addr, $file)){
    return undef;
  }
  $self->{'rand'} = int(rand(1 << 24));
  $self->_xfer(
    $self->ccCopyProtocol(1),
    $self->ccCopySourceFileType(1),
    $self->ccCopyServerAddress($addr),
    $self->ccCopyFileName($file),
    $self->ccCopyDestFileType(4),
    $self->ccCopyEntryRowStatus(4)
  );
}

sub error {
###
### -- Return last error message

  my($self)	= shift;

  defined($self->{err}) ? $self->{err} : '' ;
}

sub _newarg {
###
### -- Parse new object arguments

  my($self)	= shift;
  my(%arg)	= @_;

  foreach(keys %arg){
    $self->{'host'}  = $arg{$_}, next if /^Host$/oi;	## - SNMP host
    $self->{'comm'}  = $arg{$_}, next if /^Comm$/oi;	## - SNMP community
    $self->{'tmout'} = $arg{$_}, next if /^tmout$/oi;	## - SNMP timeout
    $self->{'retry'} = $arg{$_}, next if /^Retry$/oi;	## - SNMP timeout
  }
}

sub _cktftp {
###
### -- Check tftp arguments

  my($self)	= shift;
  my($addr)	= shift;
  my($file)	= shift;

  if ($addr !~ /^[\d\.]+$/ || !defined(inet_aton($addr))) {
    $self->{err} = 'invalid tftp server address';
    return 0;
  }
  1;
}

sub _xfer {
###
### -- Do actual tftp transfer

  my($self)	= shift;
  my(@oids)	= @_;					## - OIDs to use
  my($snmp)	= $self->{'snmp'};			## - Net::SNMP subclass
  my($answer)	= '';					## - SNMP answer
  my($status)	= 0;					## - SNMP xfer status

  $snmp->set_request(@oids);				## - Start xfer
  if ($snmp->error()) {
    $self->{'err'} = $snmp->error();
    return 0;
  }
  while($status <= 2){
    $answer	= $snmp->get_request($self->ccCopyState());
    $status	= $answer->{$self->ccCopyState()};
    if ($status == 3) {					## Xfer succeeded
      last;
    }
    if ($status == 4) {					## Xfer failed
      $answer	= $snmp->get_request($self->ccCopyFailCause());
      $status	= $answer->{$self->ccCopyFailCause()};

      $self->{'err'}	= 'unknown error'	if $status == 1;
      $self->{'err'}	= 'file access error'	if $status == 2;
      $self->{'err'}	= 'tftp timeout'	if $status == 3;
      $self->{'err'}	= 'out of memory'	if $status == 4;
      $self->{'err'}	= 'no configuration'	if $status == 5;
      return 0;
    }
    sleep(2);
  }
  $snmp->set_request($self->ccCopyEntryRowStatus(6)); 	## - Clear entry row
  1;
}

### -- OIDs taken from CISCO-CONFIG-COPY-MIB-V1SMI.my
###
sub ccCopyProtocol       {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.2.'  . $_[0]->{'rand'}, INTEGER, $_[1])
}
sub ccCopySourceFileType {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.3.'  . $_[0]->{'rand'}, INTEGER, $_[1])
}
sub ccCopyDestFileType   {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.4.'  . $_[0]->{'rand'}, INTEGER, $_[1])
}
sub ccCopyServerAddress  {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.5.'  . $_[0]->{'rand'}, IPADDRESS, $_[1])
}
sub ccCopyFileName       {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.6.'  . $_[0]->{'rand'}, OCTET_STRING, $_[1])
}
sub ccCopyEntryRowStatus {
  ('1.3.6.1.4.1.9.9.96.1.1.1.1.14.' . $_[0]->{'rand'}, INTEGER, $_[1])
}
sub ccCopyState          {
  '1.3.6.1.4.1.9.9.96.1.1.1.1.10.'  . $_[0]->{'rand'}
}
sub ccCopyFailCause      {
  '1.3.6.1.4.1.9.9.96.1.1.1.1.13.'  . $_[0]->{'rand'}
}
1;							## - Needed for module

__END__