[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.22

version 1.9, 2006/07/14 02:17:29 version 1.22, 2007/01/03 19:40:03
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.21 2006/10/05 17:10:39 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 eth_list  
   returns the output from the syslog command
 returns the output from the eth list command  
   =item pipe
 =cut  
   returns the output from the pipe command
   
 my $success = 'Success.';  =item maclist
 my %COMMANDS = (  
   tftpd       => { decode => 'all',   expect => $success },  returns the output from the maclist command
   ver         => { decode => 'all' },  
   sysinfo     => { decode => 'all',   expect => $success },  =item maclist_reset
   updateflash => { decode => 'all',   expect => $success },  
   sulog       => { decode => 'sulog', expect => $success },  resets the maclist.  No useful output.
   'exit'      => { no_prompt => 1, cmd_disconnects => 1 },  
   reboot      => { no_prompt => 1, cmd_disconnects => 1 },  =item eth_list
   save_sudb   => { String => "save sudb", expect => $success },  
   syslog      => { expect => $success },  returns the output from the eth list command
   'pipe'      => { }, # XXX needs a special decode  
   maclist     => { }, # XXX needs a special decode and a special expect  =item su_info
   eth_link    => { String => "eth link", expect => $success },  
   # eth r, w and reset???  You need to pass in args => <suid> and it will return the info for that suid.
   #su password???  
   #_bootloader  =item su_testrflink
   #temp  
   #heater  you need to pass in args => <suid> and it will return the rflink test results for that SU.
 );  
   =item save_ss
 my %ALIASES = (  
   bye     => 'exit',  saves the config.  Returns 1 on success, undef on failure.
   restart => 'reboot',  
 );  =cut
   
 my %ACCESS = map { $_ => 1 } qw(  
   firmware_version  my $success = 'Success.';
   host_type  my %COMMANDS = (
   Host    tftpd       => { decode => 'all',   expect => $success },
   is_connected    ver         => { decode => 'all' },
   logged_in    sysinfo     => { decode => 'all',   expect => $success },
   login_banner    updateflash => { decode => 'all',   expect => $success },
   Timeout    sulog       => { decode => 'sulog', expect => $success },
   last_lines    'exit'      => { no_prompt => 1, cmd_disconnects => 1 },
   last_vals    reboot      => { no_prompt => 1, cmd_disconnects => 1 },
 );    remarks     => { decode => 'all', expect => $success },
     save_sudb   => { String => 'save sudb', expect => $success },
 sub AUTOLOAD    syslog      => { expect => $success },
 {    'pipe'      => { }, # XXX needs a special decode
   my $self = shift;    maclist     => { decode => 'maclist' },
     maclist_reset => { String => 'maclist reset', expect => 'done' },
   my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/    eth_link    => { String => 'eth link', expect => $success },
     or die "Weird: $AUTOLOAD";    su_info     => { String => 'su info', decode => 'all', expect => $success },
     su_testrflink=> { String => 'su testrflink', decode => 'each', expect => $success },
   if (exists $ALIASES{$method}) {    save_ss     => { String => 'save ss', expect => $success },
     $method = $ALIASES{$method};    opmode      => { decode => 'all',   expect => $success },
     return $self->$method(@_);    # eth r, w and reset???
   }    #su password???
     #_bootloader
   if (exists $COMMANDS{$method}) {    #temp
     $method = shift if (@_ == 1);    #heater
     $COMMANDS{$method}{'String'} ||= $method;  );
     return $self->cmd(%{ $COMMANDS{$method} }, @_);  
   }  my %ALIASES = (
     bye     => 'exit',
   if (exists $ACCESS{$method}) {    restart => 'reboot',
     my $prev = $PRIVATE{$method};  );
     ($PRIVATE{$method}) = @_ if @_;  
     return $prev;  my %ACCESS = map { $_ => 1 } qw(
   }    firmware_version
     host_type
   $method = "SUPER::$method";    Host
   return $self->$method(@_);    is_connected
 }    logged_in
     login_banner
 =pod    Timeout
     last_lines
 =item open    last_vals
   );
 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()  
   sub AUTOLOAD
 =cut  {
     my $self = shift;
 sub open  
 {    my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
   my $self = shift;      or die "Weird: $AUTOLOAD";
   
   unless ( $self->SUPER::open(@_) ) {    if (exists $ALIASES{$method}) {
     #$! = "Couldn't connect to " . $self->Host . ":  $!";      $method = $ALIASES{$method};
     return undef;      return $self->$method(@_);
   }    }
   
   ## Get to login prompt    if (exists $COMMANDS{$method}) {
   unless ($self->waitfor(      $COMMANDS{$method}{'String'} ||= $method;
       -match => '/password: ?$/i',      $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1);
       -errmode => "return",      return $self->cmd(%{ $COMMANDS{$method} }, @_);
     ) ) {    }
     #$! = "problem connecting to host (" . $self->Host . "): " .  
     #    $self->lastline;    if (exists $ACCESS{$method}) {
     return undef;      my $prev = $PRIVATE{$method};
   }      ($PRIVATE{$method}) = @_ if @_;
       return $prev;
   $self->parse_login_banner($self->lastline);    }
   
   $self->is_connected(1);    $method = "SUPER::$method";
     return $self->$method(@_);
   return $self->is_connected;  }
 }  
   =pod
 =pod  
   =item open
 =item login  
   Calls Net::Telnet::open() then makes sure you get a password prompt so
 Calls open() if not already connected, then sends the password and sets logged_in() if successful  you are ready to login() and parses the login banner so you can get
   host_type() and firmware_version()
 =cut  
   =cut
 sub login  
 {  sub open
   my $self = shift;  {
     my $self = shift;
   unless ($self->is_connected) {  
     $self->open or return undef;    unless ( $self->SUPER::open(@_) ) {
   }      #$! = "Couldn't connect to " . $self->Host . ":  $!";
       return undef;
   my $password = shift;    }
   
   $self->print($password);    ## Get to login prompt
   unless ($self->waitfor(    unless ($self->waitfor(
     -match => $self->prompt,        -match => '/password: ?$/i',
     -errmode => "return",        -errmode => "return",
   ) ) {      ) ) {
     #$! = "login ($self->Host) failed: " . $self->lastline;      #$! = "problem connecting to host (" . $self->Host . "): " .
     return undef;      #    $self->lastline;
   }      return undef;
     }
   $self->logged_in(1);  
     $self->parse_login_banner($self->lastline);
   return $self->logged_in;  
 }    $self->is_connected(1);
   
 =pod    return $self->is_connected;
   }
 =item parse_login_banner  
   =pod
 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()  
   =item login
 =cut  
   Calls open() if not already connected, then sends the password and sets
 sub parse_login_banner  logged_in() if successful
 {  
   my $self = shift;  =cut
   
   if (@_) {  sub login
     $self->login_banner(@_);  {
   }    my $self = shift;
   
   my $banner = $self->login_banner;    unless ($self->is_connected) {
       $self->open or return undef;
   my ($type, $ver) = $banner =~    }
     /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;  
     my $password = shift;
   $self->login_banner($banner);  
   $self->host_type($type);    $self->print($password);
   $self->firmware_version($ver);    unless ($self->waitfor(
       -match => $self->prompt,
   return 1;      -errmode => "return",
 }    ) ) {
       #$! = "login ($self->Host) failed: " . $self->lastline;
 =pod      return undef;
     }
 =item su_password  
     $self->logged_in(1);
 C<su_password('all'|suid, 'new_password')>  
     return $self->logged_in;
 =cut  }
   
 sub su_password  =pod
 {  
   my $self     = shift;  =item parse_login_banner
   my $su       = shift || '!';  
   my $new_pass = 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
   unless (defined $su) {  host_type() and firmware_version() as well as login_banner()
     warn "No su passed!"  
     #return undef;  =cut
   }  
   sub parse_login_banner
   unless (defined $new_pass) {  {
     warn "No new password!"      my $self = shift;
     #return undef;  
   }    if (@_) {
       $self->login_banner(@_);
   return $self->cmd(String => 'su password ' .    }
                      $su . ' ' .  
                      $new_pass . ' ' .    my $banner = $self->login_banner;
                      $new_pass,  
                      expect => $success,    my ($type, $ver) = $banner =~
                     );      /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
 }  
     $self->login_banner($banner);
 =pod    $self->host_type($type);
     $self->firmware_version($ver);
 =item sudb_view  
     return 1;
 returns a reference to an array of hashes each containing:  }
   
   suid  =pod
   type  
   cir  =item su_password
   mir  
   mac  C<su_password('all'|suid, 'new_password')>
   
 =cut  =cut
   
 sub sudb_view  sub su_password
 {  {
   my $self = shift;    my $self     = shift;
     my $su       = shift || '!';
   my @lines = $self->cmd( String => 'sudb view', expect => $success );    my $new_pass = shift || '';
   
   return undef unless @lines;    unless (defined $su) {
       warn "No su passed!"
   unless ($PRIVATE{'Decode'}) {      #return undef;
     return @lines;    }
   }  
     unless (defined $new_pass) {
   my @sus;      warn "No new password!"
   foreach (@lines) {      #return undef;
     next unless $_;    }
     if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {  
       my %s = (    return $self->cmd(String => 'su password ' .
         suid => $1,                       $su . ' ' .
         type => $2,                       $new_pass . ' ' .
         cir  => $3,                       $new_pass,
         mir  => $4,                       expect => $success,
         mac  => $5,                      );
       );  }
   
           $s{'mac'} =~ s/\s//g;  =pod
           $s{'mac'} = uc($s{'mac'});  
   =item su_ipconfig
       push @sus, \%s;  
     }  C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>
   }  
   =cut
   return \@sus;  
 }  sub su_ipconfig
   {
 =pod          my $self        = shift;
   
 =item sudb_add          my $suid        = shift;
           my $new_ip      = shift;
 Takes the following paramaters          my $new_subnet  = shift;
           my $new_gateway = shift;
         suid : numeric,  
         type : (reg|pr)          return undef unless $suid =~ /^\d+$/;
         cir  : numeric,          return undef unless $new_ip;
         mir  : numeric,          return undef unless $new_subnet;
         mac  : Almost any format, it will be reformatted,          return undef unless $new_gateway;
   
 and returns true on success or undef otherwise.          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
           return $self->cmd(String => 'su ipconfig ' .
 You should save_sudb() after calling this, or your changes  will be lost                       $suid       . ' ' .
 when the AP is rebooted.                       $new_ip     . ' ' .
                        $new_subnet . ' ' .
 =cut                       $new_gateway,
                        expect => $success,
 sub sudb_add                      );
 {  }
         my $self = shift;  
         my $suid = shift;  =pod
         my $type = shift;  
         my $cir  = shift;  =item sudb_view
         my $mir  = shift;  
         my $mac  = shift;  returns a reference to an array of hashes each containing:
   
         if ($suid =~ /\D/) {    suid
                 return undef;    type
         }    cir
     mir
         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {    mac
                 warn "Invalid type '$type'!";  
                 return undef;  =cut
         }  
   sub sudb_view
         if ($cir =~ /\D/) {  {
                 warn "Invalid CIR '$cir'!";    my $self = shift;
                 return undef;  
         }    my @lines = $self->cmd( String => 'sudb view', expect => $success );
   
         if ($mir =~ /\D/) {    return undef unless @lines;
                 warn "Invalid MIR '$mir'!";  
                 return undef;    unless ($PRIVATE{'Decode'}) {
         }      return @lines;
     }
         my $new_mac = $mac;  
         $new_mac =~ s/[^0-9A-Fa-f]//;    my @sus;
         unless (length $new_mac == 12) {    foreach (@lines) {
                 warn "Invalid MAC '$mac'!";      next unless $_;
                 return undef;      if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
         }        my %s = (
         $new_mac = join ' ', $new_mac =~ /../g;          suid => $1,
           type => $2,
         my $string = 'sudb add ' .          cir  => $3,
                 $suid . ' ' .          mir  => $4,
                 $type . ' ' .          mac  => $5,
                 $cir  . ' ' .        );
                 $mir  . ' ' .  
                 $new_mac;            $s{'mac'} =~ s/\s//g;
             $s{'mac'} = uc($s{'mac'});
   
         return $self->cmd( String => $string, expect => $success );        push @sus, \%s;
 }      }
     }
 =pod  
     return \@sus;
 =item sudb_delete  }
   
 Takes either 'all' or the  suid of the su to delete  =pod
 and returns true on success or undef otherwise.  
   =item sudb_add
 You should save_sudb() after calling this, or your changes  will be lost  
 when the AP is rebooted.  Takes the following paramaters
   
 =cut          suid : numeric,
           type : (reg|pr)
 sub sudb_delete          cir  : numeric,
 {          mir  : numeric,
         my $self = shift;          mac  : Almost any format, it will be reformatted,
         my $suid = shift;  
   and returns true on success or undef otherwise.
         if (lc($suid) ne 'all' || $suid =~ /\D/) {  
                 return undef;  You should save_sudb() after calling this, or your changes  will be lost
         }  when the AP is rebooted.
   
         return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );  =cut
 }  
   sub sudb_add
 =pod  {
           my $self = shift;
 =item sudb_modify          my $suid = shift;
           my $type = shift;
 Takes either the  suid of the su to delete          my $cir  = shift;
 as well as what you are changing, either "cir, mir or su2su"          my $mir  = shift;
 and returns true on success or undef otherwise.          my $mac  = shift;
   
 cir and mir also take a value to set the cir/mir to.          if ($suid =~ /\D/) {
                   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          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
 when the AP is rebooted.                  warn "Invalid type '$type'!";
                   return undef;
 =cut          }
   
 sub sudb_modify          if ($cir =~ /\D/) {
 {                  warn "Invalid CIR '$cir'!";
         my $self  = shift;                  return undef;
         my $suid  = shift;          }
         my $opt   = shift;  
         my $value = shift;          if ($mir =~ /\D/) {
                   warn "Invalid MIR '$mir'!";
         if ($suid =~ /\D/) {                  return undef;
                 return undef;          }
         }  
           my $new_mac = $mac;
         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {          $new_mac =~ s/[^0-9A-Fa-f]//;
                 if ($value =~ /\D/) {          unless (length $new_mac == 12) {
                         return undef;                  warn "Invalid MAC '$mac'!";
                 }                  return undef;
         } elsif (lc($opt) eq 'su2su') {          }
                 if ($value =~ /[^0-9A-Za-f]/) {          $new_mac = join ' ', $new_mac =~ /../g;
                         return undef;  
                 }          my $string = 'sudb add ' .
         } else {                  $suid . ' ' .
                 return undef;                  $type . ' ' .
         }                  $cir  . ' ' .
                   $mir  . ' ' .
         my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;                  $new_mac;
   
         return $self->cmd( String => $string, expect => $success );  
 }          return $self->cmd( String => $string, expect => $success );
   }
 =pod  
   =pod
 =item enable_tftpd  
   =item sudb_delete
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  
   Takes either 'all' or the  suid of the su to delete
 =cut  and returns true on success or undef otherwise.
   
 sub enable_tftpd  You should save_sudb() after calling this, or your changes  will be lost
 {  when the AP is rebooted.
   my $self = shift;  
   =cut
   my $vals = $self->tftpd( args => 'on' );  
   sub sudb_delete
   if ($vals->{'Tftpd'} eq 'listen') {  {
     return $vals;          my $self = shift;
   } else {          my $suid = shift;
     return undef;  
   }          if (lc($suid) ne 'all' || $suid =~ /\D/) {
 }                  return undef;
           }
 =pod  
           return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
 =item disable_tftpd  }
   
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  =pod
   
 =cut  =item sudb_modify
   
 sub disable_tftpd  Takes either the  suid of the su to delete
 {  as well as what you are changing, either "cir, mir or su2su"
   my $self = shift;  and returns true on success or undef otherwise.
   
   my $vals = $self->tftpd( args => 'off' );  cir and mir also take a value to set the cir/mir to.
   
   if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {  su2su takes a group id parameter that is in hex.
     return $vals;  
   } else {  You should save_sudb() after calling this, or your changes  will be lost
     return undef;  when the AP is rebooted.
   }  
 }  =cut
   
 =pod  sub sudb_modify
   {
 =item cmd          my $self  = shift;
           my $suid  = shift;
 This does most of the work.  At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.          my $opt   = shift;
           my $value = shift;
 Normally returns the last lines from from the command  
           if ($suid =~ /\D/) {
 Also accepts these options:                  return undef;
           }
 I<decode>  
 - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output          if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                   if ($value =~ /\D/) {
 I<cmd_disconnects>                          return undef;
 - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false                  }
           } elsif (lc($opt) eq 'su2su') {
 I<expect>                  if ($value =~ /[^0-9A-Za-f]/) {
 - 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                          return undef;
                   }
 I<args>          } else {
 - a string containing the command line options that are passed to the command                  return undef;
           }
 =cut  
           my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value;
 sub cmd  
 {          return $self->cmd( String => $string, expect => $success );
   my $self = shift;  }
   
   my @valid_net_telnet_opts = qw(  =pod
     String  
     Output  =item enable_tftpd
     Cmd_remove_mode  
     Errmode  runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
     Input_record_separator  
     Ors  =cut
     Output_record_separator  
     Prompt  sub enable_tftpd
     Rs  {
     Timeout    my $self = shift;
   );  
     my $vals = $self->tftpd( args => 'on' );
   my %cfg;  
   if (@_ == 1) {    if ($vals->{'Tftpd'} eq 'listen') {
     $cfg{'String'} = shift;      return $vals;
   } elsif (@_ > 1) {    } else {
     %cfg = @_;      return undef;
   }    }
   }
   $cfg{'Timeout'} ||= $self->Timeout;  
   =pod
   unless ($cfg{'String'}) {  
     #$! = "No command passed";  =item disable_tftpd
     #warn "No command passed\n";  
     return undef;  runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   }  
   =cut
   unless ($self->is_connected) {  
     #$! = "Not connected";  sub disable_tftpd
     #warn "Not connected\n";  {
     return undef;    my $self = shift;
   }  
     my $vals = $self->tftpd( args => 'off' );
   unless ($self->logged_in) {  
     #$! = "Not logged in";    if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
     #warn "Not logged in\n";      return $vals;
     return undef;    } else {
   }      return undef;
     }
   }
   my %cmd;  
   foreach (@valid_net_telnet_opts) {  =pod
     if (exists $cfg{$_}) {  
       $cmd{$_} = $cfg{$_};  =item cmd
     }  
   }  This does most of the work.  At the heart, it calls Net::Telnet::cmd()
   if ($cfg{'args'}) {  but it also does some special stuff for Trango.
     $cmd{'String'} .= ' ' . $cfg{'args'};  
   }  Normally returns the last lines from from the command
   my @lines;  
   unless ($cfg{'no_prompt'}) {  Also accepts these options:
     @lines = $self->SUPER::cmd(%cmd);  
   } else {  I<decode>
     $self->print($cmd{'String'});  - if this is true, then it will send the output lines to _decode_lines()
     @lines = $self->lastline;  and then returns the decoded output
   }  
   I<cmd_disconnects>
   $self->last_lines(\@lines);  - 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 $vals = 1;  
   if ($PRIVATE{'Decode'} && $cfg{'decode'}) {  I<expect>
     if ($cfg{'decode'} eq 'each') {  - if this is set (usually to 'Success.') it will check for that in the
       $vals = _decode_each_line(@lines);  last line of output and if it does not, will return undef because the
     } elsif ($cfg{'decode'} eq 'sulog') {  command probably failed
       $vals = _decode_sulog(@lines);  
     } else {  I<args>
       $vals = _decode_lines(@lines);  - a string containing the command line options that are passed to the
     }  command
   }  
   =cut
   $self->last_vals($vals);  
   sub cmd
   {
   my $last = $self->lastline;    my $self = shift;
   
   if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {    my @valid_net_telnet_opts = qw(
     if ($cfg{'cmd_disconnects'}) {      String
       $self->logged_in(0);      Output
       $self->close;      Cmd_remove_mode
       $self->is_connected(0);      Errmode
     }      Input_record_separator
       Ors
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {      Output_record_separator
       return $vals;      Prompt
     } else {      Rs
       return @lines;      Timeout
     }    );
   } else {  
     #$! = "Error with command ($cfg{'string'}): $last";    my %cfg;
     return undef;    if (@_ == 1) {
   }      $cfg{'String'} = shift;
 }    } elsif (@_ > 1) {
       %cfg = @_;
 #=item _decode_lines    }
   
 sub _decode_lines    $cfg{'Timeout'} ||= $self->Timeout;
 {  
   my @lines = @_;    unless ($cfg{'String'}) {
       #$! = "No command passed";
   my %conf;      #warn "No command passed\n";
       return undef;
   my $key = '';    }
   my $val = '';  
   my $in_key = 0;    unless ($self->is_connected) {
   my $in_val = 0;      #$! = "Not connected";
       #warn "Not connected\n";
   foreach my $line (@lines) {      return undef;
     next if $line =~ /$success$/;    }
   
     my @chars = split //, $line;    unless ($self->logged_in) {
       #$! = "Not logged in";
     my $last_key = '';      #warn "Not logged in\n";
     foreach my $c (@chars) {      return undef;
     }
       if ($c eq '[' || $c eq "\r" || $c eq "\n") {  
         if ($c eq '[') {  
           $in_key = 1;    my %cmd;
           $in_val = 0;    foreach (@valid_net_telnet_opts) {
         } else {      if (exists $cfg{$_}) {
           $in_key = 0;        $cmd{$_} = $cfg{$_};
           $in_val = 0;      }
         }    }
     if ($cfg{'args'}) {
         if ($key) {      $cmd{'String'} .= ' ' . $cfg{'args'};
           $key =~ s/^\s+//;    }
           $key =~ s/\s+$//;    my @lines;
     unless ($cfg{'no_prompt'}) {
           $val =~ s/^\s+//;      @lines = $self->SUPER::cmd(%cmd);
           $val =~ s/\s+$//;    } else {
       $self->print($cmd{'String'});
           if ($key eq 'Checksum' && $last_key) {      @lines = $self->lastline;
             # Special case for these bastids.    }
             my $new = $last_key;  
             $new =~ s/\s+\S+$//;    $self->last_lines(\@lines);
             $key = $new . " " . $key;  
           }    my $vals = 1;
     if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
           $last_key = $key;      if ($cfg{'decode'} eq 'each') {
           $conf{$key} = $val;        $vals = _decode_each_line(@lines);
           $key = '';      } elsif ($cfg{'decode'} eq 'sulog') {
           $val = '';        $vals = _decode_sulog(@lines);
         }      } elsif ($cfg{'decode'} eq 'maclist') {
         $vals = _decode_maclist(@lines);
       } elsif ($c eq ']') {      } else {
         $in_val = 1;        $vals = _decode_lines(@lines);
         $in_key = 0;      }
         $c = shift @chars;    }
   
       } elsif ($in_key) {    $self->last_vals($vals);
         $key .= $c;  
   
       } elsif ($in_val) {    my $last = $self->lastline;
         $val .= $c;  
       }    if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
     }      if ($cfg{'cmd_disconnects'}) {
   }        $self->logged_in(0);
         $self->close;
   if (%conf) {        $self->is_connected(0);
     return \%conf;      }
   } else {  
     return undef;      if ($PRIVATE{'Decode'} && $cfg{'decode'}) {
   }        return $vals;
 }      } else {
         return @lines;
 #=item _decode_each_line      }
     } else {
 sub _decode_each_line      #$! = "Error with command ($cfg{'string'}): $last";
 {      return undef;
   my @lines = @_;    }
   my @decoded;  }
   foreach my $line (@lines) {  
     my $decoded = _decode_lines($line);  #=item _decode_lines
     push @decoded, $decoded if defined $decoded;  
   }  sub _decode_lines
   return \@decoded;  {
 }    my @lines = @_;
   
 #=item _decode_sulog    my %conf;
   
 sub _decode_sulog    my $key = '';
 {    my $val = undef;
   my @lines = @_;    my $in_key = 0;
   my @decoded;    my $in_val = 1;
   my $last_tm;  
   foreach my $line (@lines) {    foreach my $line (@lines) {
     my $decoded = _decode_lines($line);      next if $line =~ /$success$/;
   
     if (defined $decoded) {      my @chars = split //, $line;
       if ($decoded->{'tm'}) {  
         $last_tm = $decoded->{'tm'};      my $last_key = '';
         next;      foreach my $c (@chars) {
       } else {  
         $decoded->{'tm'} = $last_tm;        if ($c eq '[' || $c eq "\r" || $c eq "\n") {
       }          if ($c eq '[') {
       next unless $last_tm;            $in_key = 1;
             $in_val = 0;
       push @decoded, $decoded if defined $decoded;          } else {
     }            $in_key = 0;
   }            $in_val = 1;
   return \@decoded;          }
 }  
           if ($key) {
 1;            $key =~ s/^\s+//;
 __END__            $key =~ s/\s+$//;
   
 =back            if (defined $val) {
               $val =~ s/^\s+//;
 =head1 SEE ALSO              $val =~ s/\s+$//;
             }
 Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm  
             if ($key eq 'Checksum' && $last_key) {
 L<Net::Telnet>              # Special case for these bastids.
               my $new = $last_key;
 =head1 TODO              $new =~ s/\s+\S+$//;
               $key = $new . " " . $key;
 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.            $last_key = $key;
             $conf{$key} = $val;
 =head1 AUTHOR            $key = '';
             $val = '';
 Andrew Fresh E<lt>andrew@rraz.netE<gt>          }
   
 =head1 COPYRIGHT AND LICENSE        } elsif ($c eq ']') {
           $in_val = 1;
 Copyright (C) 2005 by Andrew Fresh          $in_key = 0;
           $c = shift @chars;
 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,        } elsif ($in_key) {
 at your option, any later version of Perl 5 you may have available.          $key .= $c;
   
         } elsif ($in_val) {
 =cut          $val .= $c;
         }
       }
     }
   
     if (%conf) {
       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 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.9  
changed lines
  Added in v.1.22

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