[BACK]Return to Trango.pm CVS log [TXT][DIR] Up to [local] / trango / Net-Telnet-Trango / lib / Net / Telnet

Diff for /trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm between version 1.3 and 1.47

version 1.3, 2005/12/30 19:26:06 version 1.47, 2008/02/08 17:40:00
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.2 2005/12/30 01:02:41 andrew Exp $  
 use strict;  # $RedRiver: Trango.pm,v 1.46 2008/02/08 17:34:10 andrew Exp $
 use warnings;  use strict;
 use base 'Net::Telnet';  use warnings;
   use base 'Net::Telnet';
 =pod  
   =pod
 =head1 NAME  
   =head1 NAME
 Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface  
   Net::Telnet::Trango
 =head1 SYNOPSIS  - Perl extension for accessing the Trango telnet interface
   
   use Net::Telnet::Trango;  =head1 SYNOPSIS
   my $t = new Net::Telnet::Trango ( Timeout => 5 );  
       use Net::Telnet::Trango;
   my ($type, $version) = $t->open( Host => $fox );    my $t = new Net::Telnet::Trango ( Timeout => 5 );
     
   unless (defined $type && defined $version) {    $t->open( Host => $ap ) or die "Error connecting: $!";
     die "Error connecting: $!";  
   }    $t->login('password') or die "Couldn't log in: $!";
   
   $t->login('password') or die "Couldn't log in: $!";    # Do whatever
     
   # Do whatever    $t->exit;
       $t->close;
   $t->exit;  
   $t->close;  =head1 DESCRIPTION
   
 =head1 DESCRIPTION  Perl access to the telnet interface on Trango APs and SUs.
   
 Perl access to the telnet interface on Trango Foxes, SUs and APs.  A 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
 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.  returned.  This makes using the output from things like sysinfo very easy to
   do.
 =head2 EXPORT  
   =head2 EXPORT
 None  
   None
 =cut  
   =head1 METHODS
 our $VERSION = '0.01';  
   =cut
 my %PRIVATE = (  
   is_connected => 0,  our $VERSION = '0.01';
   logged_in => 0,  
 );  my $EMPTY = q{};
   my $SPACE = q{ };
 =pod  
   my %PRIVATE = (
 =head1 METHODS      is_connected => 0,
       logged_in    => 0,
 =head2 ACCESSORS  );
   
 =over  =pod
   
 =item Host  =head2 B<new> - Creates a new Net::Telnet::Trango object.
   
 returns the name of the host that you are accessing      new([Options from Net::Telnet,]
           [Decode => 0,]);
 =item firmware_version  
   Same as new from L<Net::Telnet> but sets the default Trango Prompt:
 returns the firmware version on the trango if available otherwise undef.    '/#> *$/'
 Available after a successful open()  
 This is usually only set internally  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
 =item host_type  instead return a reference to an array of the lines that were returned
   from the command.
 returns the type of host from the login banner for example M5830S or M5300S.    
 Available after a successful open()  =cut
 This is usually only set internally  
   sub new {
 =item is_connected      my $class = shift;
   
 returns 1 after a successful open() otherwise undef      my %args;
 This is usually only set internally      if ( @_ == 1 ) {
           $args{'Host'} = shift;
 =item logged_in      }
       else {
 returns 1 after a successful login() 0 if it failed and undef if          %args = @_;
 login() was never called      }
 This is usually only set internally  
       $args{'Prompt'} ||= '/#> *$/';
 =item login_banner  
       foreach my $key ( keys %args ) {
 returns the banner that is displayed when first connected at login.  Only set after a successful open()          $PRIVATE{$key} = $args{$key};
       }
 This is usually only set internally      $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
       delete $args{'Decode'};
 =item last_lines  
       my $self = $class->SUPER::new(%args);
 returns the output from the last cmd() that was run as an array ref      bless $self if ref $self;
 This is usually only set internally  
       return $self;
 =back  }
   
 =head2 ALIASES  #  _password <new password> <new password>
   #  ? [command]
 =over  #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
   #  arp -bcast <on|off>
 =item bye  #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
   #  bye
 alias of exit()  #  cf2cf ap [default|<size>]
   #  date
 =item restart  #  date <month> <day> <year>
   #  freq scantable
 alias of reboot()  #  freq channeltable
   #  freq writescan [<ch#> <h|v>]
 =back  #  freq writechannel [<ch#> <freq>] ...
   #  freq <ch #> <h|v>
 =head2 COMMANDS  #  help [command]
   #  heater [<on temp> <off temp>]
 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:  #  ipconfig [<new ip> <new subnet mask> <new gateway>]
 C<tftpd(args =E<gt> 'on')> would enable tftpd  #  linktest <suid> [<pkt len, bytes> [<# of pkts> [<# of cycle>]]]
   #  log [<# of entries, 1..179>]
 =over  #  log <sum> <# of entries, 1..179>
   #  logout
 =item tftpd  #  opmode [ap [y]]
   #  password
 Returns a hash ref of the decoded output from the command.  #  ping <ip addr>
   #  polar <h|v>
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  #  power <setism|setunii> <max|min|<dBm>>
   #  reboot
 =item ver  #  restart
   #  remarks [<str>]
 Returns a hash ref of the decoded output from the command.  #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
   #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
 =item sysinfo  #  sysinfo
   #  set suid <id>
 Returns a hash ref of the decoded output from the command.  #  set apid <id>
   #  set baseid <id>
 =item exit  #  set defaultopmode [<ap|su> <min,0..10>]
   #  set defaultopmode off
 exits the command session with the trango and closes the connection  #  set snmpcomm [<read | write | trap (id or setall)> <str>]
   #  set mir [on|off]
 =item reboot  #  set mir threshold <kbps>
   #  set rssitarget [<ism|unii> <dBm>]
 reboots the trango and closes the connection  #  set serviceradius [<ism | unii> <miles>]
   #  ssrssi <ch #> <h|v>
 =cut  #  su [<suid>|all]
   #  su changechannel <all|suid> <ch#> <h|v>
 #  _password <new password> <new password>  #  su ipconfig <suid> <new ip> <new subnet> <new gateway>
 #  ? [command]  #  su [live|poweroff|priority]
 #  apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...  #  su <ping|info|status> <suid>
 #  arp -bcast <on|off>  #  su powerleveling <all|suid>
 #  bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...  #  su reboot <all|suid>
 #  bye  #  su restart <all|suid>
 #  cf2cf ap [default|<size>]  #  su testrflink <all|suid> [r]
 #  date  #  su testrflink <setlen> [64..1600]
 #  date <month> <day> <year>  #  su testrflink <aptx> [20..100]
 #  freq scantable  #  su sw <suid|all> <sw #> <on|off>
 #  freq channeltable  #  sudb [dload | view]
 #  freq writescan [<ch#> <h|v>]  #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
 #  freq writechannel [<ch#> <freq>] ...  #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
 #  freq <ch #> <h|v>  #  sudb delete <all|<suid>>
 #  help [command]  #  sudb modify <suid> <cir|mir> <kbps>
 #  heater [<on temp> <off temp>]  #  sudb modify <suid> <su2su> <group id,hex>
 #  ipconfig [<new ip> <new subnet mask> <new gateway>]  #  sudb view
 #  log [<# of entries, 1..179>]  #  sulog [lastmins | sampleperiod <1..60>]
 #  log <sum> <# of entries, 1..179>  #  sulog [<# of entry,1..18>]
 #  logout  #  survey <ism|unii> <time, sec> <h|v>
 #  opmode [ap [y]]  #  sw [<sw #> <on|off>]
 #  password  #  temp
 #  ping <ip addr>  #  tftpd [on|off]
 #  polar <h|v>  #  time
 #  power <setism|setunii> <max|min|<dBm>>  #  time <hour> <min> <sec>
 #  reboot  #  save <mainimage|fpgaimage> <current chksum> <new chksum>
 #  restart  #  save <systemsetting|sudb>
 #  remarks [<str>]  #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
 #  rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]  #  updateflash <systemsetting|sudb>
 #  rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]  
 #  sysinfo  =pod
 #  set suid <id>  
 #  set apid <id>  =head1 ACCESSORS
 #  set baseid <id>  
 #  set defaultopmode [<ap|su> <min,0..10>]  These are usually only set internally.
 #  set defaultopmode off  
 #  set snmpcomm [<read | write | trap (id or setall)> <str>]  =head2 B<firmware_version> - returns the firmware version
 #  set mir [on|off]  
 #  set mir threshold <kbps>  Returns the firmware version if available, otherwise undef.
 #  set rssitarget [<ism|unii> <dBm>]  
 #  set serviceradius [<ism | unii> <miles>]  It should be available after a successful open().
 #  ssrssi <ch #> <h|v>  
 #  su [<suid>|all]  =head2 B<host_type> - return the type of host you are connected to.
 #  su changechannel <all|suid> <ch#> <h|v>  
 #  su ipconfig <suid> <new ip> <new subnet> <new gateway>  returns the type of host from the login banner for example M5830S or M5300S.
 #  su [live|poweroff|priority]  
 #  su <ping|info|status> <suid>  Should be available after a successful open().
 #  su powerleveling <all|suid>  
 #  su reboot <all|suid>  =head2 B<is_connected> - Status of the connection to host.
 #  su restart <all|suid>  
 #  su testrflink <all|suid> [r]  returns 1 when connected, undef otherwise.
 #  su testrflink <setlen> [64..1600]  
 #  su testrflink <aptx> [20..100]  =head2 B<logged_in> - Status of being logged in to the host.
 #  su sw <suid|all> <sw #> <on|off>  
 #  sudb [dload | view]  returns 1 after a successful login(), 0 if it failed and undef if
 #  sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>  login() was never called.
 #  sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>  
 #  sudb delete <all|<suid>>  =head2 B<login_banner> - The banner when first connecting to the host.
 #  sudb modify <suid> <cir|mir> <kbps>  
 #  sudb modify <suid> <su2su> <group id,hex>  returns the banner that is displayed when first connected at login.
 #  sudb view  Only set after a successful open().
 #  sulog [lastmins | sampleperiod <1..60>]  
 #  sulog [<# of entry,1..18>]  =head2 B<last_lines> - The last lines of output from the last cmd().
 #  survey <ism|unii> <time, sec> <h|v>  
 #  sw [<sw #> <on|off>]  returns, as an array ref, the output from the last cmd() that was run.
 #  temp  
 #  tftpd [on|off]  =head2 B<last_error> - A text output of the last error that was encountered.
 #  time  
 #  time <hour> <min> <sec>  returns the last error reported.  Probably contains the last entry in
 #  save <mainimage|fpgaimage> <current chksum> <new chksum>  last_lines.
 #  save <systemsetting|sudb>  
 #  updateflash <mainimage|fpgaimage> <current chksum> <new chksum>  =head1 ALIASES
 #  updateflash <systemsetting|sudb>  
   =head2 B<bye> - alias of exit()
   
 my $success = 'Success.';  Does the same as exit()
 my %COMMANDS = (  
   tftpd       => { decode => 1, expect => $success },  =head2 B<restart> - alias of reboot()
   ver         => { decode => 1 },  
   sysinfo     => { decode => 1, expect => $success },  Does the same as reboot()
   updateflash => { decode => 1, expect => $success },  
   'exit'      => { Prompt => '//', cmd_disconnects => 1 },  =head2 B<save_systemsetting> - alias of save_ss()
   reboot      => { Prompt => '//', cmd_disconnects => 1 },  
   #su password???  Does the same as save_ss()
   #_bootloader  
   #temp  =head1 COMMANDS
   #heater  
 );  Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
   as such they accept the same options as C<cmd()>.
 my %ALIASES = (  Specifically they take a named paramater "args", for example:
   bye     => 'exit',  C<tftpd(args =E<gt> 'on')> would enable tftpd
   restart => 'reboot',  
 );  =head2 B<tftpd> - The output from the tftpd command
   
 my %ACCESS = map { $_ => 1 } qw(  Returns a hash ref of the decoded output from the
   firmware_version  command.
   host_type  
   Host  Also see enable_tftpd() and disable_tftpd() as those check that it was
   is_connected  successfully changed.
   logged_in  
   login_banner  =head2 B<ver> - The output from the ver command
   Timeout  
   last_lines  Returns a hash ref of the decoded output from the
 );  command.
   
 sub AUTOLOAD  =head2 B<sysinfo> - The output from the sysinfo command
 {  
   my $self = shift;  Returns a hash ref of the decoded output from the
   command.
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/  
     or die "Weird: $AUTOLOAD";  =head2 B<exit> - Exits the connection
   
   if (exists $ALIASES{$method}) {  exits the command session with the Trango and closes
     $method = $ALIASES{$method};  the connection
     return $self->$method(@_);  
   }  =head2 B<reboot> - Sends a reboot command
   
   if (exists $COMMANDS{$method}) {  reboots the Trango and closes the connection
     $method = shift if (@_ == 1);  
     $COMMANDS{$method}{'String'} ||= $method;  =head2 B<remarks> - Set or retrieve the remarks.
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  Takes an optional argument, which sets the remarks.
   If there is no argument, returns the current remarks.
   if (exists $ACCESS{$method}) {  
     my $prev = $PRIVATE{$method};    my $old_remarks = $t->remarks();
     ($PRIVATE{$method}) = @_ if @_;    $t->remarks($new_remarks);
     return $prev;  
   }  =head2 B<sulog> - The output from the sulog command
   
   $method = "SUPER::$method";  Returns an array ref of hashes containing each log
   return $self->$method(@_);  line.
 }  
   =head2 B<save_sudb> - saves the sudb
 =pod  
   Returns true on success, undef on failure
 =item new  
   =head2 B<syslog> - The output from the sulog command
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  
   Returns a hashref of the output from the syslog command
 =cut  
   =head2 B<pipe> - the pipe command
 sub new  
 {  Returns the output from the pipe command
   my $class = shift;  
   =head2 B<maclist> - retrieves the maclist
   my %args;  
   if (@_ == 1) {  Returns the output from the maclist command
     $args{'Host'} = shift;  
   } else {  =head2 B<maclist_reset> - resets the maclist.
     %args = @_;  
   }  No useful output.
   
   $args{'Prompt'}  ||= '/#> *$/';  =head2 B<eth_link> - eth link command
   
   foreach my $key (keys %args) {  Returns the output from the eth link command
     $PRIVATE{$key} = $args{$key};  
   }  This command seems to cause some weird issues.  It often will cause the
   command after it to appear to fail.  I am not sure why.
   my $self = $class->SUPER::new(%args);  
   bless $self if ref $self;  =head2 B<su_info> - gets the su info
   
   return $self;  Returns information about the SU.
 }  
   You need to pass in the $suid and it will return the info for that suid.
 =pod  
     $t->su_info($suid);
 =item open  
   =head2 B<su_testrflink> - tests the RF Link to an su
 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()  
     $t->su_testrflink($suid|'all');
 =cut  
   =head2 B<save_ss> - saves the config.
 sub open  
 {  Returns 1 on success, undef on failure.
   my $self = shift;  
   =head2 B<opmode> - sets opmode ap y or returns the opmode
   unless ( $self->SUPER::open(@_) ) {  
     #$! = "Couldn't connect to " . $self->Host . ":  $!";      $t->opmode([ap y]);
     return undef;  
   }  =cut
   
   ## Get to login prompt  my $success  = 'Success\\.';
   unless ($self->waitfor(  my %COMMANDS = (
       -match => '/password: ?$/i',      _clear      => { String => "\n" },
       -errmode => "return",      tftpd       => { decode    => 'all',       expect          => $success },
     ) ) {      ver         => { decode    => 'all' },
     #$! = "problem connecting to host (" . $self->Host . "): " .      sysinfo     => { decode    => 'all',       expect          => $success },
     #    $self->lastline;      updateflash => { decode    => 'all',       expect          => $success },
     return undef;      sulog       => { decode    => 'sulog',     expect          => $success },
   }      'exit'      => { no_prompt => 1,           cmd_disconnects => 1 },
       reboot      => { no_prompt => 1,           cmd_disconnects => 1 },
   $self->parse_login_banner($self->lastline);      remarks     => { decode    => 'all',       expect          => $success },
       save_sudb   => { String    => 'save sudb', expect          => $success },
   $self->is_connected(1);      syslog      => { expect    => $success },
       'pipe'      => {},                        # XXX needs a special decode
   return $self->is_connected;      maclist     => { decode => 'maclist' },
 }      maclist_reset => { String => 'maclist reset', expect       => 'done' },
       eth_link    => { String => 'eth link',     expect          => $success },
 =pod      su_info     =>
         { String => 'su info',  decode => 'all', expect          => $success },
 =item login      su_testrflink =>
         { String => 'su testrflink', decode => 'each', expect    => $success },
 Calls open() if not already connected, then sends the password and sets logged_in() if successful      save_ss     => { String => 'save ss',      expect          => $success },
       opmode      => { decode => 'all',          expect          => $success },
 =cut      arq         => { decode => 'all' },
   );
 sub login  
 {  my %ALIASES = (
   my $self = shift;      bye     => 'exit',
       restart => 'reboot',
   unless ($self->is_connected) {      Host    => 'host',
     $self->open or return undef;      save_systemseting => 'save_ss',
   }  );
   
   my $password = shift;  my %ACCESS = map { $_ => 1 } qw(
     firmware_version
   $self->print($password);    host_type
   unless ($self->waitfor(    is_connected
     -match => $self->prompt,    logged_in
     -errmode => "return",    login_banner
   ) ) {    Timeout
     #$! = "login ($self->Host) failed: " . $self->lastline;    last_lines
     return undef;    last_vals
   }    last_error
     Decode
   $self->logged_in(1);  );
   
   return $self->logged_in;  sub AUTOLOAD {
 }      my $self = shift;
   
 =pod      my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/
         or die "Weird: $AUTOLOAD";
 =item parse_login_banner  
       if ( exists $ALIASES{$method} ) {
 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()          $method = $ALIASES{$method};
           return $self->$method(@_);
 =cut      }
   
 sub parse_login_banner      if ( exists $COMMANDS{$method} ) {
 {          my %cmd;
   my $self = shift;          foreach my $k ( keys %{ $COMMANDS{$method} } ) {
               $cmd{$k} = $COMMANDS{$method}{$k};
   if (@_) {          }
     $self->login_banner(@_);          $cmd{'String'} ||= $method;
   }          $cmd{'args'} .= $SPACE . shift if ( @_ == 1 );
           return $self->cmd( %cmd, @_ );
   my $banner = $self->login_banner;      }
   
   my ($type, $ver) = $banner =~      if ( exists $ACCESS{$method} ) {
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;          my $prev = $PRIVATE{$method};
           ( $PRIVATE{$method} ) = @_ if @_;
   $self->login_banner($banner);          return $prev;
   $self->host_type($type);      }
   $self->firmware_version($ver);  
       $method = "SUPER::$method";
   return 1;      return $self->$method(@_);
 }  }
   
 =pod  =pod
   
 =item enable_tftpd  =head2 B<open> - Open a connection to a Trango AP.
   
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  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
 =cut  host_type() and firmware_version()
   
 sub enable_tftpd  =cut
 {  
   my $self = shift;  sub open {
       my $self = shift;
   my $vals = $self->tftpd( args => 'on' );  
       unless ( $self->SUPER::open(@_) ) {
   if ($vals->{'Tftpd'} eq 'listen') {          $self->last_error( "Couldn't connect to " . $self->host . ":  $!" );
     return $vals;          return;
   } else {      }
     return undef;  
   }      ## Get to login prompt
 }      unless (
           $self->waitfor(
 =pod              -match   => '/password: ?$/i',
               -errmode => "return",
 =item disable_tftpd          )
         )
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'      {
           $self->last_error( "problem connecting to host ("
 =cut                . $self->host . "): "
                 . $self->lastline );
 sub disable_tftpd          return;
 {      }
   my $self = shift;  
       $self->parse_login_banner( $self->lastline );
   my $vals = $self->tftpd( args => 'off' );  
       $self->is_connected(1);
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  
     return $vals;      return $self->is_connected;
   } else {  }
     return undef;  
   }  =pod
 }  
   =head2 B<login> - Login to the AP.
 =pod  
   Calls open() if not already connected, then sends the password and sets
 =item cmd  logged_in() if successful
   
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.  =cut
   
 Normally returns the last lines from from the command  sub login {
       my $self = shift;
 Also accepts these options:  
       unless ( $self->is_connected ) {
 I<decode>          $self->open or return;
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output      }
   
 I<cmd_disconnects>      my $password = shift;
 - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false  
       $self->print($password);
 I<expect>      unless (
 - 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          $self->waitfor(
               -match   => $self->prompt,
 I<args>              -errmode => "return",
 - a string containing the command line options that are passed to the command          )
         )
 =cut      {
           $self->last_error( "login ($self->host) failed: " . $self->lastline );
 sub cmd          return;
 {      }
   my $self = shift;  
       $self->logged_in(1);
   my @valid_net_telnet_opts = qw(  
     String      return $self->logged_in;
     Output  }
     Cmd_remove_mode  
     Errmode  =pod
     Input_record_separator  
     Ors  =head2 B<parse_login_banner> - Converts the login_banner to something useful.
     Output_record_separator  
     Prompt  Takes a login banner (what you get when you first connect to the Trango)
     Rs  or reads what is already in login_banner() then parses it and sets
     Timeout  host_type() and firmware_version() as well as login_banner()
   );  
   =cut
   my %cfg;  
   if (@_ == 2) {  sub parse_login_banner {
     $cfg{'String'} = shift;      my $self = shift;
   } elsif (@_ > 2) {  
     %cfg = @_;      if (@_) {
   }          $self->login_banner(@_);
       }
   $cfg{'Timeout'} ||= $self->Timeout;  
       my $banner = $self->login_banner;
   unless ($cfg{'String'}) {  
     #$! = "No command passed";      my ( $type, $sep1, $subtype, $sep2, $ver ) =
     #warn "No command passed\n";        $banner =~
     return undef;        /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
   }  
       $type .= $sep1 . $subtype;
   unless ($self->is_connected) {      $ver = $subtype . $sep2 . $ver;
     #$! = "Not connected";  
     #warn "Not connected\n";      $self->login_banner($banner);
     return undef;      $self->host_type($type);
   }      $self->firmware_version($ver);
   
   unless ($self->logged_in) {      return 1;
     #$! = "Not logged in";  }
     #warn "Not logged in\n";  
     return undef;  =pod
   }  
   =head2 B<linktest> - Link test to SU
   
   my %cmd;  linktest('suid'[, 'pkt len, bytes'[, '# of pkts'[, '# of cycles']]]);
   foreach (@valid_net_telnet_opts) {  
     if (exists $cfg{$_}) {  Returns a hash reference to the results of the test
       $cmd{$_} = $cfg{$_};  
     }  =cut
   }  
   if ($cfg{'args'}) {  sub linktest
     $cmd{'String'} .= ' ' . $cfg{'args'};  {
   }      my $self    = shift;
   my @lines = $self->SUPER::cmd(%cmd);      my $suid    = shift;
       # These numbers are what I found as defaults when running the command
   $self->last_lines(\@lines);      my $pkt_len = shift || 1600;
       my $pkt_cnt = shift || 500;
   my $vals = 1;      my $cycles  = shift || 10;
   if ($cfg{'decode'}) {  
     $vals = _decode_lines(@lines);      my %config  = @_;
   }  
       # * 2, one for the FromAP, one FromSU.  Then / 1000 to get to ms.
       # XXX This might need to be changed, this makes the default timeout the
   my $last = $self->lastline;      # same as $pkt_len, and that might not be enough at slower speeds.
       $config{Timeout} ||= int(($pkt_len * $pkt_cnt * $cycles * 2 ) / 1000);
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {  
     if ($cfg{'cmd_disconnects'}) {      my $string = join $SPACE, 'linktest', $suid, $pkt_len, $pkt_cnt, $cycles;
       $self->logged_in(0);      return $self->cmd(
       $self->close;          %config,
       $self->is_connected(0);          String => $string,
     }          decode => 'linktest',
       );
     if ($cfg{'decode'}) {  
       return $vals;  }
     } else {  
       return @lines;  =pod
     }  
   } else {  =head2 B<su_password> - Set the password on SUs connected to the AP.
     #$! = "Error with command ($cfg{'string'}): $last";  
     return undef;  su_password('new_password'[, 'suid']) If no suid is specified,
   }  the default is "all".
 }  
     $t->su_password('good_pass', 5);
 #=item _decode_lines  
   =cut
 sub _decode_lines  
 {  sub su_password {
   my @lines = @_;      my $self     = shift;
       my $new_pass = shift || $EMPTY;
   my %conf;      my $su       = shift || 'all';
   
   my $key = '';      unless ( defined $new_pass ) {
   my $val = '';          $self->last_error("No new password");
   my $in_key = 0;  
   my $in_val = 0;          #return;
       }
   foreach my $line (@lines) {  
     my @chars = split //, $line;      return $self->cmd(
           String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass,
     my $last_key = '';          expect => $success,
     foreach my $c (@chars) {      );
   }
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  
         if ($c eq '[') {  =pod
           $in_key = 1;  
           $in_val = 0;  =head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP.
         } else {  
           $in_key = 0;  su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
           $in_val = 0;  
         }    $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
   
         if ($key) {  =cut
           $key =~ s/^\s+//;  
           $key =~ s/\s+$//;  sub su_ipconfig {
       my $self = shift;
           $val =~ s/^\s+//;  
           $val =~ s/\s+$//;      my $suid        = shift;
       my $new_ip      = shift;
           if ($key eq 'Checksum' && $last_key) {      my $new_subnet  = shift;
             # Special case for these bastids.      my $new_gateway = shift;
             my $new = $last_key;  
             $new =~ s/\s+\S+$//;      if ( $suid =~ /\D/ ) {
             $key = $new . " " . $key;          $self->last_error("Invalid suid '$suid'");
           }          return;
       }
           $last_key = $key;      unless ($new_ip) {
           $conf{$key} = $val;          $self->last_error("no new_ip passed");
           $key = '';          return;
           $val = '';      }
         }      unless ($new_subnet) {
           $self->last_error("no new_subnet passed");
       } elsif ($c eq ']') {          return;
         $in_val = 1;      }
         $in_key = 0;      unless ($new_gateway) {
         $c = shift @chars;          $self->last_error("no new_gateway passed");
           return;
       } elsif ($in_key) {      }
         $key .= $c;  
       # su ipconfig <suid> <new ip> <new subnet> <new gateway>
       } elsif ($in_val) {      return $self->cmd(
         $val .= $c;          String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE
       }            . $new_subnet . $SPACE
     }            . $new_gateway,
   }          expect => $success,
       );
   if (%conf) {  }
     return \%conf;  
   } else {  =pod
     return \@lines;  
   }  =head2 B<sudb_view> - Returns the output from the sudb view command
 }  
   returns a reference to an array of hashes each containing these keys
 1;  'suid', 'type', 'cir', 'mir' and 'mac'
 __END__  
   =cut
 =back  
   sub sudb_view {
 =head1 SEE ALSO      my $self = shift;
   
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm      my $lines = $self->cmd( String => 'sudb view', expect => $success ) || [];
   
 L<Net::Telnet>      return unless @{$lines};
   
 =head1 TODO      unless ( $PRIVATE{'Decode'} ) {
           return $lines;
 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.      my @sus;
       foreach ( @{$lines} ) {
 =head1 AUTHOR          next unless $_;
           if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
 Andrew Fresh E<lt>andrew@rraz.netE<gt>              my %s = (
                   suid => $1,
 =head1 COPYRIGHT AND LICENSE                  type => $2,
                   cir  => $3,
 Copyright (C) 2005 by Andrew Fresh                  mir  => $4,
                   mac  => $5,
 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.              $s{'mac'} =~ s/\s//g;
               $s{'mac'} = uc( $s{'mac'} );
   
 =cut              push @sus, \%s;
           }
       }
   
       return \@sus;
   }
   
   =pod
   
   =head2 B<sudb_add> - Adds an su to the sudb
   
   Takes the following paramaters
   
       suid : numeric,
       type : (reg|pr)
       cir  : numeric,
       mir  : numeric,
       mac  : Almost any format, it will be reformatted,
   
   and returns true on success or undef otherwise.
   
     $t->sudb_add($suid, 'reg', $cir, $mir, $mac);
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_add {
       my $self = shift;
       my $suid = shift;
       my $type = shift;
       my $cir  = shift;
       my $mir  = shift;
       my $mac  = shift;
   
       if ( $suid =~ /\D/ ) {
           $self->last_error("Invalid suid '$suid'");
           return;
       }
   
       unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) {
           $self->last_error("Invalid type '$type'");
           return;
       }
   
       if ( $cir =~ /\D/ ) {
           $self->last_error("Invalid CIR '$cir'");
           return;
       }
   
       if ( $mir =~ /\D/ ) {
           $self->last_error("Invalid MIR '$mir'");
           return;
       }
   
       my $new_mac = $mac;
       $new_mac =~ s/[^0-9A-Fa-f]//;
       unless ( length $new_mac == 12 ) {
           $self->last_error("Invalid MAC '$mac'");
           return;
       }
       $new_mac = join $SPACE, $new_mac =~ /../g;
   
       my $string =
         'sudb add ' . $suid . $SPACE . $type . $SPACE . $cir . $SPACE . $mir . $SPACE
         . $new_mac;
   
       return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =head2 B<sudb_delete> - removes an su from the sudb
   
   Takes either 'all' or the  suid of the su to delete
   and returns true on success or undef otherwise.
   
     $t->sudb_delete($suid);
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_delete {
       my $self = shift;
       my $suid = shift;
   
       #if (lc($suid) ne 'all' || $suid =~ /\D/) {
       if ( $suid =~ /\D/ ) {
           $self->last_error("Invalid suid '$suid'");
           return;
       }
   
       return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
   }
   
   =pod
   
   =head2 B<sudb_modify> - changes the su information in the sudb
   
   Takes either the  suid of the su to change
   as well as what you are changing, either "cir, mir or su2su"
   and returns true on success or undef otherwise.
   
   cir and mir also take a value to set the cir/mir to.
   
   su2su takes a group id parameter that is in hex.
   
     $t->sudb_modify($suid, 'cir', 512);
   
   You should save_sudb() after calling this, or your changes  will be lost
   when the AP is rebooted.
   
   =cut
   
   sub sudb_modify {
       my $self  = shift;
       my $suid  = shift;
       my $opt   = shift;
       my $value = shift;
   
       if ( $suid =~ /\D/ ) {
           $self->last_error("Invalid suid '$suid'");
           return;
       }
   
       if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) {
           if ( $value =~ /\D/ ) {
               $self->last_error("Invalid $opt '$value'");
               return;
           }
       }
       elsif ( lc($opt) eq 'su2su' ) {
           if ( $value =~ /[^0-9A-Za-f]/ ) {
               $self->last_error("Invalid MAC '$value'");
               return;
           }
       }
       else {
           $self->last_error("Invalid option '$opt'");
           return;
       }
   
       my $string = 'sudb modify ' . $suid . $SPACE . $opt . $SPACE . $value;
   
       return $self->cmd( String => $string, expect => $success );
   }
   
   =pod
   
   =head2 B<enable_tftpd> - enable the TFTP server
   
   runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
   =cut
   
   sub enable_tftpd {
       my $self = shift;
   
       my $vals = $self->tftpd( args => 'on' );
   
       if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) {
           return $vals;
       }
       else {
           return;
       }
   }
   
   =pod
   
   =head2 B<disable_tftpd> - disable the TFTP server
   
   runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
   =cut
   
   sub disable_tftpd {
       my $self = shift;
   
       my $vals = $self->tftpd( args => 'off' );
   
       if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled' ) {
           return $vals;
       }
       else {
           return;
       }
   }
   
   =pod
   
   =head2 B<cmd> - runs a command on the AP.
   
   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
   
   If you are using this, rather than one of the "easy" methods above,
   you probably want to read through the source of this module to see how
   some of the other commands are called.
   
   In addition to the Net::Telnet::cmd() options, it also accepts these:
   
   I<decode>
   - if this is true, then it will send the output lines to _decode_lines()
   and then returns the decoded output
   
   I<no_prompt>
   - if this is true, it does not wait for a prompt, so you are not stuck
   waiting for something that will never happen.
   
   I<cmd_disconnects>
   - if this is true, it then sets logged_in() to false, then it will
   close() the connection and set is_connected() to false
   
   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
   
   I<args>
   - a string containing the command line options that are passed to the
   command
   
       $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 );
   
   =cut
   
   sub cmd {
       my $self = shift;
   
       my @valid_net_telnet_opts = qw(
         String
         Output
         Cmd_remove_mode
         Errmode
         Input_record_separator
         Ors
         Output_record_separator
         Prompt
         Rs
         Timeout
       );
   
       my %cfg;
       if ( @_ == 1 ) {
           $cfg{'String'} = shift;
       }
       elsif ( @_ > 1 ) {
           %cfg = @_;
       }
   
       $cfg{'Timeout'} ||= $self->Timeout;
   
       unless ( $cfg{'String'} ) {
           $self->last_error("No command passed");
           return;
       }
   
       unless ( $self->is_connected ) {
           $self->last_error("Not connected");
           return;
       }
   
       unless ( $self->logged_in ) {
           $self->last_error("Not logged in");
           return;
       }
   
       my %cmd;
       foreach (@valid_net_telnet_opts) {
           if ( exists $cfg{$_} ) {
               $cmd{$_} = $cfg{$_};
           }
       }
       if ( $cfg{'args'} ) {
           $cmd{'String'} .= $SPACE . $cfg{'args'};
       }
   
       #print "Running cmd $cmd{String}\n";
       my @lines;
       if ( $cfg{'no_prompt'} ) {
           $self->print( $cmd{'String'} );
           @lines = $self->lastline;
       }
       else {
           @lines = $self->SUPER::cmd(%cmd);
       }
   
       $self->last_lines( \@lines );
   
       my $vals = 1;
       if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
           if ( $cfg{'decode'} eq 'each' ) {
               $vals = _decode_each_line(@lines);
           }
           elsif ( $cfg{'decode'} eq 'sulog' ) {
               $vals = _decode_sulog(@lines);
           }
           elsif ( $cfg{'decode'} eq 'maclist' ) {
               $vals = _decode_maclist(@lines);
               if (! $vals) {
                   $self->last_error("Error decoding maclist");
               }
           }
           elsif ( $cfg{'decode'} eq 'linktest' ) {
               $vals = _decode_linktest(@lines);
               if (! $vals) {
                   $self->last_error("Error decoding linktest");
               }
           }
           else {
               $vals = _decode_lines(@lines);
           }
       }
   
       $self->last_vals($vals);
   
       my $last = $self->lastline;
       $self->last_error($EMPTY);
   
       if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) {
           if ( $cfg{'cmd_disconnects'} ) {
               $self->logged_in(0);
               $self->close;
               $self->is_connected(0);
           }
   
           if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
               return $vals;
           }
           else {
               return \@lines;
           }
       }
       else {
           my $err;
           if (grep { /\[ERR\]/ } @lines) {
               $err = _decode_lines(@lines);
           }
   
           if (ref $err eq 'HASH' && $err->{ERR}) {
               $self->last_error($err->{ERR} );
           } else {
               $self->last_error("Error with command ($cmd{'String'}): $last");
           }
           return;
       }
   }
   
   #=item _decode_lines
   
   sub _decode_lines {
       my @lines = @_;
   
       my %conf;
   
       my $key = $EMPTY;
       my $val = undef;
       my @vals;
       my $in_key = 0;
       my $in_val = 1;
   
       foreach my $line (@lines) {
           next if $line =~ /$success$/;
   
           my @chars = split //, $line;
   
           my $last_key = $EMPTY;
           foreach my $c (@chars) {
   
               if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) {
                   if ( $c eq '[' ) {
                       $in_key = 1;
                       $in_val = 0;
                   }
                   else {
                       $in_key = 0;
                       $in_val = 1;
                   }
   
                   if ($key) {
                       $key =~ s/^\s+//;
                       $key =~ s/\s+$//;
   
                       if ($val) {
                           $val =~ s/^\s+//;
                           $val =~ s/\s+$//;
                       }
   
                       if ( $key eq 'Checksum' && $last_key ) {
   
                           # Special case for these bastids.
                           my $new = $last_key;
                           $new =~ s/\s+\S+$//;
                           $key = $new . $SPACE . $key;
                       }
   
                       $conf{$key} = $val;
                       $last_key   = $key;
                       $key        = $EMPTY;
                   }
                   elsif ($val) {
                       push @vals, $val;
                   }
                   $val = $EMPTY;
   
               }
               elsif ( $c eq ']' ) {
                   $in_val = 1;
                   $in_key = 0;
                   $c      = shift @chars;
   
               }
               elsif ($in_key) {
                   $key .= $c;
   
               }
               elsif ($in_val) {
                   $val .= $c;
               }
           }
       }
   
       unless ($key) {
           push @vals, $val;
       }
   
       if ( @vals == 1 ) {
           $val = $vals[0];
       }
       elsif (@vals) {
           $val = \@vals;
       }
       else {
           $val = undef;
       }
   
       if (%conf) {
           $conf{_pre} = $val if $val;
           return \%conf;
       }
       else {
           return $val;
       }
   }
   
   #=item _decode_each_line
   
   sub _decode_each_line {
       my @lines = @_;
       my @decoded;
       foreach my $line (@lines) {
           my $decoded = _decode_lines($line);
           push @decoded, $decoded if defined $decoded;
       }
       return \@decoded;
   }
   
   #=item _decode_linktest
   
   sub _decode_linktest {
       my @lines = @_;
       my %decoded;
       foreach my $line (@lines) {
   
           if ($line =~ s/^(\d+) \s*//xms) {
               my $line_id = $1;
               my $d = _decode_lines($line . "\n");
               $decoded{tests}[$line_id] = $d;
           }
   
           else {
               my $d = _decode_lines($line . "\n");
               if ($d) {
                   while (my ($k, $v) = each %{ $d }) {
                       $decoded{$k} = $v;
                   }
              }
           }
   
       }
       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 {
           return;
       }
   }
   
   1;    # End of Net::Telnet::Trango
   __END__
   
   =head1 SEE ALSO
   
   Trango Documentation -
   L<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 SUPPORT
   
   You can find documentation for this module with the perldoc command.
   
       perldoc Net::Telnet::Trango
   
   You can also look for information at:
   
   =over 4
   
   =item * AnnoCPAN: Annotated CPAN documentation
   
   L<http://annocpan.org/dist/Net-Telnet-Trango>
   
   =item * CPAN Ratings
   
   L<http://cpanratings.perl.org/d/Net-Telnet-Trango>
   
   =item * RT: CPAN's request tracker
   
   L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Telnet-Trango>
   
   =item * Search CPAN
   
   L<http://search.cpan.org/dist/Net-Telnet-Trango>
   
   =back
   
   =head1 COPYRIGHT AND LICENSE
   
   Copyright (C) 2005,2006,2007 by Andrew Fresh
   
   This program is free software; you can redistribute it and/or modify it
   under the same terms as Perl itself.
   
   =cut
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.47
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>