[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.9 and 1.29

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