[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.8 and 1.33

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