[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.5 and 1.43

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