[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.13 and 1.20

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

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