[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.35 and 1.59

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

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