trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm - diff

Return to Trango.pm CVS log

Up to [local] / trango / Net-Telnet-Trango / lib / Net / Telnet

Diff for /trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm between version 1.9 and 1.17

-version 1.9, 2006/07/14 02:17:29
+version 1.17, 2006/09/12 02:17:46
 Line 1
 Line 1
 Line 1
  package Net::Telnet::Trango;
- # $RedRiver: Trango.pm,v 1.8 2006/06/29 00:39:52 andrew Exp $
+ # $RedRiver: Trango.pm,v 1.16 2006/09/07 03:00:07 andrew Exp $
  use strict;
  use warnings;
  use base 'Net::Telnet';
  =pod
  =head1 NAME
  Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface
  =head1 SYNOPSIS
    use Net::Telnet::Trango;
    my $t = new Net::Telnet::Trango ( Timeout => 5 );
    $t->open( Host => $fox ) or die "Error connecting: $!";
    $t->login('password') or die "Couldn't log in: $!";
    # Do whatever
    $t->exit;
    $t->close;
  =head1 DESCRIPTION
  Perl access to the telnet interface on Trango Foxes, SUs and APs.
  Another handy feature is that it will parse the output from certain commands that is in the format "[key1] value1 [key2] value2" and put those in a hashref that is returned.  This makes using the output from things like sysinfo very easy to do.
  =head2 EXPORT
  None
  =cut
  our $VERSION = '0.01';
  my %PRIVATE = (
    is_connected => 0,
    logged_in => 0,
  );
  =pod
  =item new
  Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
  It also takes an optional parameter 'Decode'.  If not defined it
  defaults to 1, if it is set to 0, it will not decode the output and
  instead return an array of the lines that were returned from the
  command.
  =cut
  sub new
  {
    my $class = shift;
    my %args;
    if (@_ == 1) {
      $args{'Host'} = shift;
    } else {
      %args = @_;
    }
    $args{'Prompt'}  ||= '/#> *$/';
    foreach my $key (keys %args) {
      $PRIVATE{$key} = $args{$key};
    }
    $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
    delete $args{'Decode'};
    my $self = $class->SUPER::new(%args);
    bless $self if ref $self;
    return $self;
  }
  #  _password <new password> <new password>
  #  ? [command]
  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
  #  arp -bcast <on|off>
  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
  #  bye
  #  cf2cf ap [default|<size>]
  #  date
  #  date <month> <day> <year>
  #  freq scantable
  #  freq channeltable
  #  freq writescan [<ch#> <h|v>]
  #  freq writechannel [<ch#> <freq>] ...
  #  freq <ch #> <h|v>
  #  help [command]
  #  heater [<on temp> <off temp>]
  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
  #  log [<# of entries, 1..179>]
  #  log <sum> <# of entries, 1..179>
  #  logout
  #  opmode [ap [y]]
  #  password
  #  ping <ip addr>
  #  polar <h|v>
  #  power <setism|setunii> <max|min|<dBm>>
  #  reboot
  #  restart
  #  remarks [<str>]
  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
  #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
  #  sysinfo
  #  set suid <id>
  #  set apid <id>
  #  set baseid <id>
  #  set defaultopmode [<ap|su> <min,0..10>]
  #  set defaultopmode off
  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
  #  set mir [on|off]
  #  set mir threshold <kbps>
  #  set rssitarget [<ism|unii> <dBm>]
  #  set serviceradius [<ism | unii> <miles>]
  #  ssrssi <ch #> <h|v>
  #  su [<suid>|all]
  #  su changechannel <all|suid> <ch#> <h|v>
  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
  #  su [live|poweroff|priority]
  #  su <ping|info|status> <suid>
  #  su powerleveling <all|suid>
  #  su reboot <all|suid>
  #  su restart <all|suid>
  #  su testrflink <all|suid> [r]
  #  su testrflink <setlen> [64..1600]
  #  su testrflink <aptx> [20..100]
  #  su sw <suid|all> <sw #> <on|off>
  #  sudb [dload | view]
  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
  #  sudb delete <all|<suid>>
  #  sudb modify <suid> <cir|mir> <kbps>
  #  sudb modify <suid> <su2su> <group id,hex>
  #  sudb view
  #  sulog [lastmins | sampleperiod <1..60>]
  #  sulog [<# of entry,1..18>]
  #  survey <ism|unii> <time, sec> <h|v>
  #  sw [<sw #> <on|off>]
  #  temp
  #  tftpd [on|off]
  #  time
  #  time <hour> <min> <sec>
  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
  #  save <systemsetting|sudb>
  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
  #  updateflash <systemsetting|sudb>
  =pod
  =head1 METHODS
  =head2 ACCESSORS
  =over
  =item Host
  returns the name of the host that you are accessing
  =item firmware_version
  returns the firmware version on the trango if available otherwise undef.
  Available after a successful open()
  This is usually only set internally
  =item host_type
  returns the type of host from the login banner for example M5830S or M5300S.
  Available after a successful open()
  This is usually only set internally
  =item is_connected
  returns 1 after a successful open() otherwise undef
  This is usually only set internally
  =item logged_in
  returns 1 after a successful login() 0 if it failed and undef if
  login() was never called
  This is usually only set internally
  =item login_banner
  returns the banner that is displayed when first connected at login.  Only set after a successful open()
  This is usually only set internally
  =item last_lines
  returns the output from the last cmd() that was run as an array ref
  This is usually only set internally
  =back
  =head2 ALIASES
  =over
  =item bye
  alias of exit()
  =item restart
  alias of reboot()
  =back
  =head2 COMMANDS
  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>, as such they accept the same options as C<cmd()>.  Specifically they take a named paramater "args", for example:
  C<tftpd(args =E<gt> 'on')> would enable tftpd
  =over
  =item tftpd
  Returns a hash ref of the decoded output from the command.
  Also see enable_tftpd() and disable_tftpd() as those check for correct output
  =item ver
  Returns a hash ref of the decoded output from the command.
  =item sysinfo
  Returns a hash ref of the decoded output from the command.
  =item exit
  exits the command session with the trango and closes the connection
  =item reboot
  reboots the trango and closes the connection
- =item sulog
+ =item remarks
- returns an array ref of hashes containing each log line.
+ Takes an optional argument "args => <remarks>", which sets the remarks.
+ If there is no argument, just returns the current remarks.
- =item save_sudb
+ =item sulog
- returns true on success, undef on failure
+ returns an array ref of hashes containing each log line.
- =item syslog
+ =item save_sudb
- returns the output from the syslog command
+ returns true on success, undef on failure
- =item pipe
+ =item syslog
- returns the output from the pipe command
+ returns the output from the syslog command
- =item maclist
+ =item pipe
- returns the output from the maclist command
+ returns the output from the pipe command
- =item eth_list
+ =item maclist
- returns the output from the eth list command
+ returns the output from the maclist command
- =cut
+ =item maclist_reset
- my $success = 'Success.';
+ resets the maclist.  No useful output.
- my %COMMANDS = (
-   tftpd       => { decode => 'all',   expect => $success },
+ =item eth_list
-   ver         => { decode => 'all' },
-   sysinfo     => { decode => 'all',   expect => $success },
+ returns the output from the eth list command
-   updateflash => { decode => 'all',   expect => $success },
-   sulog       => { decode => 'sulog', expect => $success },
+ =item su_info
-   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
-   reboot      => { no_prompt => 1, cmd_disconnects => 1 },
+ You need to pass in args => <suid> and it will return the info for that suid.
-   save_sudb   => { String => "save sudb", expect => $success },
-   syslog      => { expect => $success },
+ =item save_ss
-   'pipe'      => { }, # XXX needs a special decode
-   maclist     => { }, # XXX needs a special decode and a special expect
+ saves the config.  Returns 1 on success, undef on failure.
-   eth_link    => { String => "eth link", expect => $success },
-   # eth r, w and reset???
+ =cut
-   #su password???
-   #_bootloader
-   #temp
+ my $success = 'Success.';
-   #heater
+ my %COMMANDS = (
- );
+   tftpd       => { decode => 'all',   expect => $success },
+   ver         => { decode => 'all' },
- my %ALIASES = (
+   sysinfo     => { decode => 'all',   expect => $success },
-   bye     => 'exit',
+   updateflash => { decode => 'all',   expect => $success },
-   restart => 'reboot',
+   sulog       => { decode => 'sulog', expect => $success },
- );
+   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
+   reboot      => { no_prompt => 1, cmd_disconnects => 1 },
- my %ACCESS = map { $_ => 1 } qw(
+   remarks     => { decode => 'all', expect => $success },
-   firmware_version
+   save_sudb   => { String => 'save sudb', expect => $success },
-   host_type
+   syslog      => { expect => $success },
-   Host
+   'pipe'      => { }, # XXX needs a special decode
-   is_connected
+   maclist     => { decode => 'maclist' },
-   logged_in
+   maclist_reset => { String => 'maclist reset', expect => 'done' },
-   login_banner
+   eth_link    => { String => 'eth link', expect => $success },
-   Timeout
+   su_info     => { String => 'su info', decode => 'all', expect => $success },
-   last_lines
+   save_ss     => { String => 'save ss', expect => $success },
-   last_vals
+   # eth r, w and reset???
- );
+   #su password???
+   #_bootloader
- sub AUTOLOAD
+   #temp
- {
+   #heater
-   my $self = shift;
+ );
-   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
+ my %ALIASES = (
-     or die "Weird: $AUTOLOAD";
+   bye     => 'exit',
+   restart => 'reboot',
-   if (exists $ALIASES{$method}) {
+ );
-     $method = $ALIASES{$method};
-     return $self->$method(@_);
+ my %ACCESS = map { $_ => 1 } qw(
-   }
+   firmware_version
+   host_type
-   if (exists $COMMANDS{$method}) {
+   Host
-     $method = shift if (@_ == 1);
+   is_connected
-     $COMMANDS{$method}{'String'} ||= $method;
+   logged_in
-     return $self->cmd(%{ $COMMANDS{$method} }, @_);
+   login_banner
-   }
+   Timeout
+   last_lines
-   if (exists $ACCESS{$method}) {
+   last_vals
-     my $prev = $PRIVATE{$method};
+ );
-     ($PRIVATE{$method}) = @_ if @_;
-     return $prev;
+ sub AUTOLOAD
-   }
+ {
+   my $self = shift;
-   $method = "SUPER::$method";
-   return $self->$method(@_);
+   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
- }
+     or die "Weird: $AUTOLOAD";
- =pod
+   if (exists $ALIASES{$method}) {
+     $method = $ALIASES{$method};
- =item open
+     return $self->$method(@_);
+   }
- Calls Net::Telnet::open() then makes sure you get a password prompt so you are ready to login() and parses the login banner so you can get host_type() and firmware_version()
+   if (exists $COMMANDS{$method}) {
- =cut
+     $COMMANDS{$method}{'String'} ||= $method;
+     $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
- sub open
+     return $self->cmd(%{ $COMMANDS{$method} }, @_);
- {
+   }
-   my $self = shift;
+   if (exists $ACCESS{$method}) {
-   unless ( $self->SUPER::open(@_) ) {
+     my $prev = $PRIVATE{$method};
-     #$! = "Couldn't connect to " . $self->Host . ":  $!";
+     ($PRIVATE{$method}) = @_ if @_;
-     return undef;
+     return $prev;
    }
-   ## Get to login prompt
+   $method = "SUPER::$method";
-   unless ($self->waitfor(
+   return $self->$method(@_);
-       -match => '/password: ?$/i',
+ }
-       -errmode => "return",
-     ) ) {
+ =pod
-     #$! = "problem connecting to host (" . $self->Host . "): " .
-     #    $self->lastline;
+ =item open
-     return undef;
-   }
+ Calls Net::Telnet::open() then makes sure you get a password prompt so you are ready to login() and parses the login banner so you can get host_type() and firmware_version()
-   $self->parse_login_banner($self->lastline);
+ =cut
-   $self->is_connected(1);
+ sub open
+ {
-   return $self->is_connected;
+   my $self = shift;
- }
+   unless ( $self->SUPER::open(@_) ) {
- =pod
+     #$! = "Couldn't connect to " . $self->Host . ":  $!";
+     return undef;
- =item login
+   }
- Calls open() if not already connected, then sends the password and sets logged_in() if successful
+   ## Get to login prompt
+   unless ($self->waitfor(
- =cut
+       -match => '/password: ?$/i',
+       -errmode => "return",
- sub login
+     ) ) {
- {
+     #$! = "problem connecting to host (" . $self->Host . "): " .
-   my $self = shift;
+     #    $self->lastline;
+     return undef;
-   unless ($self->is_connected) {
+   }
-     $self->open or return undef;
-   }
+   $self->parse_login_banner($self->lastline);
-   my $password = shift;
+   $self->is_connected(1);
-   $self->print($password);
+   return $self->is_connected;
-   unless ($self->waitfor(
+ }
-     -match => $self->prompt,
-     -errmode => "return",
+ =pod
-   ) ) {
-     #$! = "login ($self->Host) failed: " . $self->lastline;
+ =item login
-     return undef;
-   }
+ Calls open() if not already connected, then sends the password and sets logged_in() if successful
-   $self->logged_in(1);
+ =cut
-   return $self->logged_in;
+ sub login
- }
+ {
+   my $self = shift;
- =pod
+   unless ($self->is_connected) {
- =item parse_login_banner
+     $self->open or return undef;
+   }
- Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner()
+   my $password = shift;
- =cut
+   $self->print($password);
- sub parse_login_banner
+   unless ($self->waitfor(
- {
+     -match => $self->prompt,
-   my $self = shift;
+     -errmode => "return",
+   ) ) {
-   if (@_) {
+     #$! = "login ($self->Host) failed: " . $self->lastline;
-     $self->login_banner(@_);
+     return undef;
    }
-   my $banner = $self->login_banner;
+   $self->logged_in(1);
-   my ($type, $ver) = $banner =~
+   return $self->logged_in;
-     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
+ }
-   $self->login_banner($banner);
+ =pod
-   $self->host_type($type);
-   $self->firmware_version($ver);
+ =item parse_login_banner
-   return 1;
+ Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner()
- }
+ =cut
- =pod
+ sub parse_login_banner
- =item su_password
+ {
+   my $self = shift;
- C<su_password('all'|suid, 'new_password')>
+   if (@_) {
- =cut
+     $self->login_banner(@_);
+   }
- sub su_password
- {
+   my $banner = $self->login_banner;
-   my $self     = shift;
-   my $su       = shift || '!';
+   my ($type, $ver) = $banner =~
-   my $new_pass = shift || '';
+     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
-   unless (defined $su) {
+   $self->login_banner($banner);
-     warn "No su passed!"
+   $self->host_type($type);
-     #return undef;
+   $self->firmware_version($ver);
-   }
+   return 1;
-   unless (defined $new_pass) {
+ }
-     warn "No new password!"
-     #return undef;
+ =pod
-   }
+ =item su_password
-   return $self->cmd(String => 'su password ' .
-                      $su . ' ' .
+ C<su_password('all'|suid, 'new_password')>
-                      $new_pass . ' ' .
-                      $new_pass,
+ =cut
-                      expect => $success,
-                     );
+ sub su_password
- }
+ {
+   my $self     = shift;
- =pod
+   my $su       = shift || '!';
+   my $new_pass = shift || '';
- =item sudb_view
+   unless (defined $su) {
- returns a reference to an array of hashes each containing:
+     warn "No su passed!"
+     #return undef;
-   suid
+   }
-   type
-   cir
+   unless (defined $new_pass) {
-   mir
+     warn "No new password!"
-   mac
+     #return undef;
+   }
- =cut
+   return $self->cmd(String => 'su password ' .
- sub sudb_view
+                      $su . ' ' .
- {
+                      $new_pass . ' ' .
-   my $self = shift;
+                      $new_pass,
+                      expect => $success,
-   my @lines = $self->cmd( String => 'sudb view', expect => $success );
+                     );
+ }
-   return undef unless @lines;
+ =pod
-   unless ($PRIVATE{'Decode'}) {
-     return @lines;
+ =item su_ipconfig
-   }
+ C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
-   my @sus;
-   foreach (@lines) {
+ =cut
-     next unless $_;
-     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
+ sub su_ipconfig
-       my %s = (
+ {
-         suid => $1,
+         my $self        = shift;
-         type => $2,
-         cir  => $3,
+         my $suid        = shift;
-         mir  => $4,
+         my $new_ip      = shift;
-         mac  => $5,
+         my $new_subnet  = shift;
-       );
+         my $new_gateway = shift;
-           $s{'mac'} =~ s/\s//g;
+         return undef unless $suid =~ /^\d+$/;
-           $s{'mac'} = uc($s{'mac'});
+         return undef unless $new_ip;
+         return undef unless $new_subnet;
-       push @sus, \%s;
+         return undef unless $new_gateway;
-     }
-   }
+         # su ipconfig <suid> <new ip> <new subnet> <new gateway>
+         return $self->cmd(String => 'su ipconfig ' .
-   return \@sus;
+                      $suid       . ' ' .
- }
+                      $new_ip     . ' ' .
+                      $new_subnet . ' ' .
- =pod
+                      $new_gateway,
+                      expect => $success,
- =item sudb_add
+                     );
+ }
- Takes the following paramaters
+ =pod
-         suid : numeric,
-         type : (reg|pr)
+ =item sudb_view
-         cir  : numeric,
-         mir  : numeric,
+ returns a reference to an array of hashes each containing:
-         mac  : Almost any format, it will be reformatted,
+   suid
- and returns true on success or undef otherwise.
+   type
+   cir
- You should save_sudb() after calling this, or your changes  will be lost
+   mir
- when the AP is rebooted.
+   mac
  =cut
- sub sudb_add
+ sub sudb_view
  {
-         my $self = shift;
+   my $self = shift;
-         my $suid = shift;
-         my $type = shift;
+   my @lines = $self->cmd( String => 'sudb view', expect => $success );
-         my $cir  = shift;
-         my $mir  = shift;
+   return undef unless @lines;
-         my $mac  = shift;
+   unless ($PRIVATE{'Decode'}) {
-         if ($suid =~ /\D/) {
+     return @lines;
-                 return undef;
+   }
-         }
+   my @sus;
-         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
+   foreach (@lines) {
-                 warn "Invalid type '$type'!";
+     next unless $_;
-                 return undef;
+     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
-         }
+       my %s = (
+         suid => $1,
-         if ($cir =~ /\D/) {
+         type => $2,
-                 warn "Invalid CIR '$cir'!";
+         cir  => $3,
-                 return undef;
+         mir  => $4,
-         }
+         mac  => $5,
+       );
-         if ($mir =~ /\D/) {
-                 warn "Invalid MIR '$mir'!";
+           $s{'mac'} =~ s/\s//g;
-                 return undef;
+           $s{'mac'} = uc($s{'mac'});
-         }
+       push @sus, \%s;
-         my $new_mac = $mac;
+     }
-         $new_mac =~ s/[^0-9A-Fa-f]//;
+   }
-         unless (length $new_mac == 12) {
-                 warn "Invalid MAC '$mac'!";
+   return \@sus;
-                 return undef;
+ }
-         }
-         $new_mac = join ' ', $new_mac =~ /../g;
+ =pod
-         my $string = 'sudb add ' .
+ =item sudb_add
-                 $suid . ' ' .
-                 $type . ' ' .
+ Takes the following paramaters
-                 $cir  . ' ' .
-                 $mir  . ' ' .
+         suid : numeric,
-                 $new_mac;
+         type : (reg|pr)
+         cir  : numeric,
+         mir  : numeric,
-         return $self->cmd( String => $string, expect => $success );
+         mac  : Almost any format, it will be reformatted,
- }
+ and returns true on success or undef otherwise.
- =pod
+ You should save_sudb() after calling this, or your changes  will be lost
- =item sudb_delete
+ when the AP is rebooted.
- Takes either 'all' or the  suid of the su to delete
+ =cut
- and returns true on success or undef otherwise.
+ sub sudb_add
- You should save_sudb() after calling this, or your changes  will be lost
+ {
- when the AP is rebooted.
+         my $self = shift;
+         my $suid = shift;
- =cut
+         my $type = shift;
+         my $cir  = shift;
- sub sudb_delete
+         my $mir  = shift;
- {
+         my $mac  = shift;
-         my $self = shift;
-         my $suid = shift;
+         if ($suid =~ /\D/) {
+                 return undef;
-         if (lc($suid) ne 'all' || $suid =~ /\D/) {
+         }
-                 return undef;
-         }
+         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
+                 warn "Invalid type '$type'!";
-         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
+                 return undef;
- }
+         }
- =pod
+         if ($cir =~ /\D/) {
+                 warn "Invalid CIR '$cir'!";
- =item sudb_modify
+                 return undef;
+         }
- Takes either the  suid of the su to delete
- as well as what you are changing, either "cir, mir or su2su"
+         if ($mir =~ /\D/) {
- and returns true on success or undef otherwise.
+                 warn "Invalid MIR '$mir'!";
+                 return undef;
- cir and mir also take a value to set the cir/mir to.
+         }
- su2su takes a group id parameter that is in hex.
+         my $new_mac = $mac;
+         $new_mac =~ s/[^0-9A-Fa-f]//;
- You should save_sudb() after calling this, or your changes  will be lost
+         unless (length $new_mac == 12) {
- when the AP is rebooted.
+                 warn "Invalid MAC '$mac'!";
+                 return undef;
- =cut
+         }
+         $new_mac = join ' ', $new_mac =~ /../g;
- sub sudb_modify
- {
+         my $string = 'sudb add ' .
-         my $self  = shift;
+                 $suid . ' ' .
-         my $suid  = shift;
+                 $type . ' ' .
-         my $opt   = shift;
+                 $cir  . ' ' .
-         my $value = shift;
+                 $mir  . ' ' .
+                 $new_mac;
-         if ($suid =~ /\D/) {
-                 return undef;
-         }
+         return $self->cmd( String => $string, expect => $success );
+ }
-         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
-                 if ($value =~ /\D/) {
+ =pod
-                         return undef;
-                 }
+ =item sudb_delete
-         } elsif (lc($opt) eq 'su2su') {
-                 if ($value =~ /[^0-9A-Za-f]/) {
+ Takes either 'all' or the  suid of the su to delete
-                         return undef;
+ and returns true on success or undef otherwise.
-                 }
-         } else {
+ You should save_sudb() after calling this, or your changes  will be lost
-                 return undef;
+ when the AP is rebooted.
-         }
+ =cut
-         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
+ sub sudb_delete
-         return $self->cmd( String => $string, expect => $success );
+ {
- }
+         my $self = shift;
+         my $suid = shift;
- =pod
+         if (lc($suid) ne 'all' || $suid =~ /\D/) {
- =item enable_tftpd
+                 return undef;
+         }
- runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
+         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
- =cut
+ }
- sub enable_tftpd
+ =pod
- {
-   my $self = shift;
+ =item sudb_modify
-   my $vals = $self->tftpd( args => 'on' );
+ Takes either the  suid of the su to delete
+ as well as what you are changing, either "cir, mir or su2su"
-   if ($vals->{'Tftpd'} eq 'listen') {
+ and returns true on success or undef otherwise.
-     return $vals;
-   } else {
+ cir and mir also take a value to set the cir/mir to.
-     return undef;
-   }
+ su2su takes a group id parameter that is in hex.
- }
+ You should save_sudb() after calling this, or your changes  will be lost
- =pod
+ when the AP is rebooted.
- =item disable_tftpd
+ =cut
- runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
+ sub sudb_modify
+ {
- =cut
+         my $self  = shift;
+         my $suid  = shift;
- sub disable_tftpd
+         my $opt   = shift;
- {
+         my $value = shift;
-   my $self = shift;
+         if ($suid =~ /\D/) {
-   my $vals = $self->tftpd( args => 'off' );
+                 return undef;
+         }
-   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
-     return $vals;
+         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
-   } else {
+                 if ($value =~ /\D/) {
-     return undef;
+                         return undef;
-   }
+                 }
- }
+         } elsif (lc($opt) eq 'su2su') {
+                 if ($value =~ /[^0-9A-Za-f]/) {
- =pod
+                         return undef;
+                 }
- =item cmd
+         } else {
+                 return undef;
- This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.
+         }
- Normally returns the last lines from from the command
+         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
- Also accepts these options:
+         return $self->cmd( String => $string, expect => $success );
+ }
- I<decode>
- - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output
+ =pod
- I<cmd_disconnects>
+ =item enable_tftpd
- - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false
+ runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
- I<expect>
- - if this is set (usually to 'Success.') it will check for that in the last line of output and if it does not, will return undef because the command probably failed
+ =cut
- I<args>
+ sub enable_tftpd
- - a string containing the command line options that are passed to the command
+ {
+   my $self = shift;
- =cut
+   my $vals = $self->tftpd( args => 'on' );
- sub cmd
- {
+   if ($vals->{'Tftpd'} eq 'listen') {
-   my $self = shift;
+     return $vals;
+   } else {
-   my @valid_net_telnet_opts = qw(
+     return undef;
-     String
+   }
-     Output
+ }
-     Cmd_remove_mode
-     Errmode
+ =pod
-     Input_record_separator
-     Ors
+ =item disable_tftpd
-     Output_record_separator
-     Prompt
+ runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
-     Rs
-     Timeout
+ =cut
-   );
+ sub disable_tftpd
-   my %cfg;
+ {
-   if (@_ == 1) {
+   my $self = shift;
-     $cfg{'String'} = shift;
-   } elsif (@_ > 1) {
+   my $vals = $self->tftpd( args => 'off' );
-     %cfg = @_;
-   }
+   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
+     return $vals;
-   $cfg{'Timeout'} ||= $self->Timeout;
+   } else {
+     return undef;
-   unless ($cfg{'String'}) {
+   }
-     #$! = "No command passed";
+ }
-     #warn "No command passed\n";
-     return undef;
+ =pod
-   }
+ =item cmd
-   unless ($self->is_connected) {
-     #$! = "Not connected";
+ This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.
-     #warn "Not connected\n";
-     return undef;
+ Normally returns the last lines from from the command
-   }
+ Also accepts these options:
-   unless ($self->logged_in) {
-     #$! = "Not logged in";
+ I<decode>
-     #warn "Not logged in\n";
+ - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output
-     return undef;
-   }
+ I<cmd_disconnects>
+ - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false
-   my %cmd;
+ I<expect>
-   foreach (@valid_net_telnet_opts) {
+ - if this is set (usually to 'Success.') it will check for that in the last line of output and if it does not, will return undef because the command probably failed
-     if (exists $cfg{$_}) {
-       $cmd{$_} = $cfg{$_};
+ I<args>
-     }
+ - a string containing the command line options that are passed to the command
-   }
-   if ($cfg{'args'}) {
+ =cut
-     $cmd{'String'} .= ' ' . $cfg{'args'};
-   }
+ sub cmd
-   my @lines;
+ {
-   unless ($cfg{'no_prompt'}) {
+   my $self = shift;
-     @lines = $self->SUPER::cmd(%cmd);
-   } else {
+   my @valid_net_telnet_opts = qw(
-     $self->print($cmd{'String'});
+     String
-     @lines = $self->lastline;
+     Output
-   }
+     Cmd_remove_mode
+     Errmode
-   $self->last_lines(\@lines);
+     Input_record_separator
+     Ors
-   my $vals = 1;
+     Output_record_separator
-   if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
+     Prompt
-     if ($cfg{'decode'} eq 'each') {
+     Rs
-       $vals = _decode_each_line(@lines);
+     Timeout
-     } elsif ($cfg{'decode'} eq 'sulog') {
+   );
-       $vals = _decode_sulog(@lines);
-     } else {
+   my %cfg;
-       $vals = _decode_lines(@lines);
+   if (@_ == 1) {
-     }
+     $cfg{'String'} = shift;
-   }
+   } elsif (@_ > 1) {
+     %cfg = @_;
-   $self->last_vals($vals);
+   }
+   $cfg{'Timeout'} ||= $self->Timeout;
-   my $last = $self->lastline;
+   unless ($cfg{'String'}) {
-   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
+     #$! = "No command passed";
-     if ($cfg{'cmd_disconnects'}) {
+     #warn "No command passed\n";
-       $self->logged_in(0);
+     return undef;
-       $self->close;
+   }
-       $self->is_connected(0);
-     }
+   unless ($self->is_connected) {
+     #$! = "Not connected";
-     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
+     #warn "Not connected\n";
-       return $vals;
+     return undef;
-     } else {
+   }
-       return @lines;
-     }
+   unless ($self->logged_in) {
-   } else {
+     #$! = "Not logged in";
-     #$! = "Error with command ($cfg{'string'}): $last";
+     #warn "Not logged in\n";
      return undef;
    }
- }
- #=item _decode_lines
+   my %cmd;
+   foreach (@valid_net_telnet_opts) {
- sub _decode_lines
+     if (exists $cfg{$_}) {
- {
+       $cmd{$_} = $cfg{$_};
-   my @lines = @_;
+     }
+   }
-   my %conf;
+   if ($cfg{'args'}) {
+     $cmd{'String'} .= ' ' . $cfg{'args'};
-   my $key = '';
+   }
-   my $val = '';
+   my @lines;
-   my $in_key = 0;
+   unless ($cfg{'no_prompt'}) {
-   my $in_val = 0;
+     @lines = $self->SUPER::cmd(%cmd);
+   } else {
-   foreach my $line (@lines) {
+     $self->print($cmd{'String'});
-     next if $line =~ /$success$/;
+     @lines = $self->lastline;
+   }
-     my @chars = split //, $line;
+   $self->last_lines(\@lines);
-     my $last_key = '';
-     foreach my $c (@chars) {
+   my $vals = 1;
+   if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
-       if ($c eq '[' || $c eq "\r" || $c eq "\n") {
+     if ($cfg{'decode'} eq 'each') {
-         if ($c eq '[') {
+       $vals = _decode_each_line(@lines);
-           $in_key = 1;
+     } elsif ($cfg{'decode'} eq 'sulog') {
-           $in_val = 0;
+       $vals = _decode_sulog(@lines);
-         } else {
+     } elsif ($cfg{'decode'} eq 'maclist') {
-           $in_key = 0;
+       $vals = _decode_maclist(@lines);
-           $in_val = 0;
+     } else {
-         }
+       $vals = _decode_lines(@lines);
+     }
-         if ($key) {
+   }
-           $key =~ s/^\s+//;
-           $key =~ s/\s+$//;
+   $self->last_vals($vals);
-           $val =~ s/^\s+//;
-           $val =~ s/\s+$//;
+   my $last = $self->lastline;
-           if ($key eq 'Checksum' && $last_key) {
+   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
-             # Special case for these bastids.
+     if ($cfg{'cmd_disconnects'}) {
-             my $new = $last_key;
+       $self->logged_in(0);
-             $new =~ s/\s+\S+$//;
+       $self->close;
-             $key = $new . " " . $key;
+       $self->is_connected(0);
-           }
+     }
-           $last_key = $key;
+     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
-           $conf{$key} = $val;
+       return $vals;
-           $key = '';
+     } else {
-           $val = '';
+       return @lines;
-         }
+     }
+   } else {
-       } elsif ($c eq ']') {
+     #$! = "Error with command ($cfg{'string'}): $last";
-         $in_val = 1;
+     return undef;
-         $in_key = 0;
+   }
-         $c = shift @chars;
+ }
-       } elsif ($in_key) {
+ #=item _decode_lines
-         $key .= $c;
+ sub _decode_lines
-       } elsif ($in_val) {
+ {
-         $val .= $c;
+   my @lines = @_;
-       }
-     }
+   my %conf;
-   }
+   my $key = '';
-   if (%conf) {
+   my $val = undef;
-     return \%conf;
+   my $in_key = 0;
-   } else {
+   my $in_val = 1;
-     return undef;
-   }
+   foreach my $line (@lines) {
- }
+     next if $line =~ /$success$/;
- #=item _decode_each_line
+     my @chars = split //, $line;
- sub _decode_each_line
+     my $last_key = '';
- {
+     foreach my $c (@chars) {
-   my @lines = @_;
-   my @decoded;
+       if ($c eq '[' || $c eq "\r" || $c eq "\n") {
-   foreach my $line (@lines) {
+         if ($c eq '[') {
-     my $decoded = _decode_lines($line);
+           $in_key = 1;
-     push @decoded, $decoded if defined $decoded;
+           $in_val = 0;
-   }
+           $val = '';
-   return \@decoded;
+         } else {
- }
+           $in_key = 0;
+           $in_val = 1;
- #=item _decode_sulog
+         }
- sub _decode_sulog
+         if ($key) {
- {
+           $key =~ s/^\s+//;
-   my @lines = @_;
+           $key =~ s/\s+$//;
-   my @decoded;
-   my $last_tm;
+           if (defined $val) {
-   foreach my $line (@lines) {
+             $val =~ s/^\s+//;
-     my $decoded = _decode_lines($line);
+             $val =~ s/\s+$//;
+           }
-     if (defined $decoded) {
-       if ($decoded->{'tm'}) {
+           if ($key eq 'Checksum' && $last_key) {
-         $last_tm = $decoded->{'tm'};
+             # Special case for these bastids.
-         next;
+             my $new = $last_key;
-       } else {
+             $new =~ s/\s+\S+$//;
-         $decoded->{'tm'} = $last_tm;
+             $key = $new . " " . $key;
-       }
+           }
-       next unless $last_tm;
+           $last_key = $key;
-       push @decoded, $decoded if defined $decoded;
+           $conf{$key} = $val;
-     }
+           $key = '';
-   }
+           $val = '';
-   return \@decoded;
+         }
- }
+       } elsif ($c eq ']') {
-;
+         $in_val = 1;
- __END__
+         $in_key = 0;
+         $c = shift @chars;
- =back
+       } elsif ($in_key) {
- =head1 SEE ALSO
+         $key .= $c;
- Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm
+       } elsif ($in_val) {
+         $val .= $c;
- L<Net::Telnet>
+       }
+     }
- =head1 TODO
+   }
- There are still a lot of commands that are not accessed directly.  If you call them (as cmd("command + args") or whatever) and it works, please send me examples that work and I will try to get it incorporated into the next version of the script.
+   if (%conf) {
+     return \%conf;
- I also want to be able to parse the different types of output from commands like su, sudb all and anything else that would be better available as a perl datastructure.
+   } else {
+     return $val;
- =head1 AUTHOR
+   }
+ }
- Andrew Fresh E<lt>andrew@rraz.netE<gt>
+ #=item _decode_each_line
- =head1 COPYRIGHT AND LICENSE
+ sub _decode_each_line
- Copyright (C) 2005 by Andrew Fresh
+ {
+   my @lines = @_;
- This library is free software; you can redistribute it and/or modify
+   my @decoded;
- it under the same terms as Perl itself, either Perl version 5.8.7 or,
+   foreach my $line (@lines) {
- at your option, any later version of Perl 5 you may have available.
+     my $decoded = _decode_lines($line);
+     push @decoded, $decoded if defined $decoded;
+   }
- =cut
+   return \@decoded;
+ }
+ #=item _decode_sulog
+ sub _decode_sulog
+ {
+   my @lines = @_;
+   my @decoded;
+   my $last_tm;
+   foreach my $line (@lines) {
+     my $decoded = _decode_lines($line);
+     if (defined $decoded) {
+       if ($decoded->{'tm'}) {
+         $last_tm = $decoded->{'tm'};
+         next;
+       } else {
+         $decoded->{'tm'} = $last_tm;
+       }
+       next unless $last_tm;
+       push @decoded, $decoded if defined $decoded;
+     }
+   }
+   return \@decoded;
+ }
+ #=item _decode_maclist
+ sub _decode_maclist
+ {
+         my @lines = @_;
+         my @decoded;
+         my $total_entries = 0;
+         my $current_tm = 0;
+         foreach my $line (@lines) {
+                 $line =~ s/\r?\n$//;
+                 my ($mac, $loc, $tm) = $line =~ /
+                         ([0-9a-fA-F ]{17})\s+
+                         (.*)\s+
+                         tm\s+
+                         (\d+)
+                 /x;
+                 if ($mac) {
+                         $mac =~ s/\s+//g;
+                         $loc =~ s/^\s+//;
+                         $loc =~ s/\s+$//;
+                         my $suid = undef;
+                         if ($loc =~ /suid\s+=\s+(\d+)/) {
+                                 $suid = $1;
+                                 $loc = undef;
+                         }
+                         push @decoded, {
+                                 mac  => $mac,
+                                 loc  => $loc,
+                                 tm   => $tm,
+                                 suid => $suid,
+                         };
+                 } elsif ($line =~ /(\d+)\s+entries/) {
+                         $total_entries = $1;
+                 } elsif ($line =~ /current tm = (\d+)\s+sec/) {
+                         $current_tm = $1
+                 }
+         }
+         map { $_->{'cur_tm'} = $current_tm } @decoded;
+         if (scalar @decoded == $total_entries) {
+                 return \@decoded;
+         } else {
+                 # XXX we should have a way to set last error, not sure why we don't
+                 return undef;
+         }
+ }
+;
+ __END__
+ =back
+ =head1 SEE ALSO
+ Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm
+ L<Net::Telnet>
+ =head1 TODO
+ There are still a lot of commands that are not accessed directly.  If you call them (as cmd("command + args") or whatever) and it works, please send me examples that work and I will try to get it incorporated into the next version of the script.
+ I also want to be able to parse the different types of output from commands like su, sudb all and anything else that would be better available as a perl datastructure.
+ =head1 AUTHOR
+ Andrew Fresh E<lt>andrew@rraz.netE<gt>
+ =head1 COPYRIGHT AND LICENSE
+ Copyright (C) 2005 by Andrew Fresh
+ This library is free software; you can redistribute it and/or modify
+ it under the same terms as Perl itself, either Perl version 5.8.7 or,
+ at your option, any later version of Perl 5 you may have available.
+ =cut

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>