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

version 1.22, 2007/01/03 19:40:03 version 1.26, 2007/01/17 23:15:13
Line 1 
Line 1 
 package Net::Telnet::Trango;  package Net::Telnet::Trango;
 # $RedRiver: Trango.pm,v 1.21 2006/10/05 17:10:39 andrew Exp $  # $RedRiver: Trango.pm,v 1.25 2007/01/17 20:48:46 andrew Exp $
 use strict;  use strict;
 use warnings;  use warnings;
 use base 'Net::Telnet';  use base 'Net::Telnet';
Line 8 
Line 8 
   
 =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;
   
Line 37 
Line 38 
   
 None  None
   
   =head1 METHODS
   
   =over
   
 =cut  =cut
   
 our $VERSION = '0.01';  our $VERSION = '0.01';
Line 48 
Line 53 
   
 =pod  =pod
   
 =item new  =item B<new>
   
 Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'  - Creates a new Net::Telnet::Trango object.
   
           new([Options from Net::Telnet,]
               [Decode => 0,]);
   
   Same as new from L<Net::Telnet> but sets the default Trango Prompt:
   '/#> *$/'
   
 It also takes an optional parameter 'Decode'.  If not defined it  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  defaults to 1, if it is set to 0, it will not decode the output and
 instead return an array of the lines that were returned from the  instead return an array of the lines that were returned from the
Line 160 
Line 171 
   
 =pod  =pod
   
 =head1 METHODS  =back
   
 =head2 ACCESSORS  =head2 ACCESSORS
   
   These are usually only set internally.
   
 =over  =over
   
 =item Host  =item B<Host>
   
 returns the name of the host that you are accessing  - returns the name of the host that you are accessing
   
 =item firmware_version  =item B<firmware_version>
   
 returns the firmware version on the trango if available otherwise undef.  - returns the firmware version
 Available after a successful open()  
 This is usually only set internally  
   
 =item host_type  Returns the firmware version if available, otherwise undef.
   
   It should be available after a successful open().
   
   =item B<host_type>
   
   - return the type of host you are connected to.
   
 returns the type of host from the login banner for example M5830S or M5300S.  returns the type of host from the login banner for example M5830S or M5300S.
 Available after a successful open()  
 This is usually only set internally  
   
 =item is_connected  Should be available after a successful open().
   
 returns 1 after a successful open() otherwise undef  =item B<is_connected>
 This is usually only set internally  
   
 =item logged_in  - Status of the connection to host.
   
 returns 1 after a successful login() 0 if it failed and undef if  returns 1 when connected, undef otherwise.
 login() was never called  
 This is usually only set internally  
   
 =item login_banner  =item B<logged_in>
   
   - Status of being logged in to the host.
   
   returns 1 after a successful login(), 0 if it failed and undef if
   login() was never called.
   
   =item B<login_banner>
   
   - The banner when first connecting to the host.
   
 returns the banner that is displayed when first connected at login.  returns the banner that is displayed when first connected at login.
 Only set after a successful open()  Only set after a successful open().
   
 This is usually only set internally  =item B<last_lines>
   
 =item last_lines  - The last lines of output from the last cmd().
   
 returns the output from the last cmd() that was run as an array ref  returns, as an array ref, the output from the last cmd() that was run.
 This is usually only set internally  
   
   =item B<last_error>
   
   - A text output of the last error that was encountered.
   
   returns the last error reported.  Probably contains the last entry in
   last_lines.
   
 =back  =back
   
 =head2 ALIASES  =head2 ALIASES
   
 =over  =over
   
 =item bye  =item B<bye>
   
 alias of exit()  - alias of L<exit()>.
   
 =item restart  =item B<restart>
   
 alias of reboot()  - alias of L<reboot()>.
   
 =back  =back
   
Line 230 
Line 257 
   
 =over  =over
   
 =item tftpd  =item B<tftpd>
   
 Returns a hash ref of the decoded output from the command.  - Returns a hash ref of the decoded output from the
   command.
   
 Also see enable_tftpd() and disable_tftpd() as those check for correct output  Also see enable_tftpd() and disable_tftpd() as those check that it was
   successfully changed.
   
 =item ver  =item B<ver>
   
 Returns a hash ref of the decoded output from the command.  - Returns a hash ref of the decoded output from the
   command.
   
 =item sysinfo  =item B<sysinfo>
   
 Returns a hash ref of the decoded output from the command.  - Returns a hash ref of the decoded output from the
   command.
   
 =item exit  =item B<exit>
   
 exits the command session with the trango and closes the connection  - exits the command session with the Trango and closes
   the connection
   
 =item reboot  =item B<reboot>
   
 reboots the trango and closes the connection  - reboots the Trango and closes the connection
   
 =item remarks  =item B<remarks>
   
   - Set or retrieve the remarks.
   
 Takes an optional argument, which sets the remarks.  Takes an optional argument, which sets the remarks.
 If there is no argument, returns the current remarks.  If there is no argument, returns the current remarks.
   
 =item sulog    my $old_remarks = $t->remarks();
     $t->remarks($new_remarks);
   
 returns an array ref of hashes containing each log line.  =item B<sulog>
   
 =item save_sudb  - returns an array ref of hashes containing each log
   line.
   
 returns true on success, undef on failure  =item B<save_sudb>
   
 =item syslog  - returns true on success, undef on failure
   
 returns the output from the syslog command  =item B<syslog>
   
 =item pipe  - returns the output from the syslog command
   
 returns the output from the pipe command  =item B<pipe>
   
 =item maclist  - returns the output from the pipe command
   
 returns the output from the maclist command  =item B<maclist>
   
 =item maclist_reset  -  returns the output from the maclist command
   
 resets the maclist.  No useful output.  =item B<maclist_reset>
   
 =item eth_list  - resets the maclist.
   
 returns the output from the eth list command  No useful output.
   
 =item su_info  =item B<eth_list>
   
 You need to pass in args => <suid> and it will return the info for that suid.  - returns the output from the eth list command
   
 =item su_testrflink  =item B<su_info>
   
 you need to pass in args => <suid> and it will return the rflink test results for that SU.  - returns information about the SU.
   
 =item save_ss  You need to pass in the $suid and it will return the info for that suid.
   
 saves the config.  Returns 1 on success, undef on failure.    $t->su_info($suid);
   
   =item B<save_ss>
   
   - saves the config.
   
   Returns 1 on success, undef on failure.
   
 =cut  =cut
   
   
Line 317 
Line 359 
   maclist_reset => { String => 'maclist reset', expect => 'done' },    maclist_reset => { String => 'maclist reset', expect => 'done' },
   eth_link    => { String => 'eth link', expect => $success },    eth_link    => { String => 'eth link', expect => $success },
   su_info     => { String => 'su info', decode => 'all', expect => $success },    su_info     => { String => 'su info', decode => 'all', expect => $success },
   su_testrflink=> { String => 'su testrflink', decode => 'each', expect => $success },  
   save_ss     => { String => 'save ss', expect => $success },    save_ss     => { String => 'save ss', expect => $success },
   opmode      => { decode => 'all',   expect => $success },    opmode      => { decode => 'all',   expect => $success },
   # eth r, w and reset???    # eth r, w and reset???
Line 342 
Line 383 
   Timeout    Timeout
   last_lines    last_lines
   last_vals    last_vals
     last_error
 );  );
   
 sub AUTOLOAD  sub AUTOLOAD
Line 374 
Line 416 
   
 =pod  =pod
   
 =item open  =item B<open>
   
   - Open a connection to a Trango AP.
   
 Calls Net::Telnet::open() then makes sure you get a password prompt so  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  you are ready to login() and parses the login banner so you can get
 host_type() and firmware_version()  host_type() and firmware_version()
Line 387 
Line 431 
   my $self = shift;    my $self = shift;
   
   unless ( $self->SUPER::open(@_) ) {    unless ( $self->SUPER::open(@_) ) {
     #$! = "Couldn't connect to " . $self->Host . ":  $!";      $self->last_error("Couldn't connect to " . $self->Host . ":  $!");
     return undef;      return undef;
   }    }
   
Line 396 
Line 440 
       -match => '/password: ?$/i',        -match => '/password: ?$/i',
       -errmode => "return",        -errmode => "return",
     ) ) {      ) ) {
     #$! = "problem connecting to host (" . $self->Host . "): " .      $self->last_error("problem connecting to host (" . $self->Host . "): " .
     #    $self->lastline;          $self->lastline);
     return undef;      return undef;
   }    }
   
Line 410 
Line 454 
   
 =pod  =pod
   
 =item login  =item B<login>
   
   - Login to the AP.
   
 Calls open() if not already connected, then sends the password and sets  Calls open() if not already connected, then sends the password and sets
 logged_in() if successful  logged_in() if successful
   
Line 432 
Line 478 
     -match => $self->prompt,      -match => $self->prompt,
     -errmode => "return",      -errmode => "return",
   ) ) {    ) ) {
     #$! = "login ($self->Host) failed: " . $self->lastline;      $self->last_error("login ($self->Host) failed: " . $self->lastline);
     return undef;      return undef;
   }    }
   
Line 443 
Line 489 
   
 =pod  =pod
   
 =item parse_login_banner  =item B<parse_login_banner>
   
   - Converts the login_banner to some useful
   variables.
   
 Takes a login banner (what you get when you first connect to the Trango)  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  or reads what is already in login_banner() then parses it and sets
 host_type() and firmware_version() as well as login_banner()  host_type() and firmware_version() as well as login_banner()
Line 473 
Line 522 
   
 =pod  =pod
   
 =item su_password  =item B<su_password>
   
 C<su_password('all'|suid, 'new_password')>  - Set the password on SUs connected to the AP.
   
   su_password('new_password'[, 'suid']) If no suid is specified,
   the default is "all".
   
     $t->su_password('good_pass', 5);
   
 =cut  =cut
   
 sub su_password  sub su_password
 {  {
   my $self     = shift;    my $self     = shift;
   my $su       = shift || '!';  
   my $new_pass = shift || '';    my $new_pass = shift || '';
     my $su       = shift || 'all';
   
   unless (defined $su) {  
     warn "No su passed!"  
     #return undef;  
   }  
   
   unless (defined $new_pass) {    unless (defined $new_pass) {
     warn "No new password!"      $self->last_error("No new password");
     #return undef;      #return undef;
   }    }
   
Line 505 
Line 554 
   
 =pod  =pod
   
 =item su_ipconfig  =item B<su_ipconfig>
   
 C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )>  - Change IP configuration on SUs connected to
   the AP.
   
   su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
   
     $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
   
 =cut  =cut
   
 sub su_ipconfig  sub su_ipconfig
Line 520 
Line 574 
         my $new_subnet  = shift;          my $new_subnet  = shift;
         my $new_gateway = shift;          my $new_gateway = shift;
   
         return undef unless $suid =~ /^\d+$/;          if ($suid =~ /\D/) {
         return undef unless $new_ip;                  $self->last_error("Invalid suid '$suid'");
         return undef unless $new_subnet;                  return undef;
         return undef unless $new_gateway;          }
           unless ($new_ip) {
                   $self->last_error("no new_ip passed");
                   return undef;
           }
           unless ($new_subnet) {
                   $self->last_error("no new_subnet passed");
                   return undef;
           }
           unless ($new_gateway) {
                   $self->last_error("no new_gateway passed");
                   return undef;
           }
   
         # su ipconfig <suid> <new ip> <new subnet> <new gateway>          # su ipconfig <suid> <new ip> <new subnet> <new gateway>
         return $self->cmd(String => 'su ipconfig ' .          return $self->cmd(String => 'su ipconfig ' .
Line 537 
Line 603 
   
 =pod  =pod
   
 =item sudb_view  =item B<sudb_view>
   
 returns a reference to an array of hashes each containing:  - Returns the output from the sudb view command
   
   suid  returns a reference to an array of hashes each containing these keys
   type  'suid', 'type', 'cir', 'mir' and 'mac'
   cir  
   mir  
   mac  
   
 =cut  =cut
   
Line 585 
Line 648 
   
 =pod  =pod
   
 =item sudb_add  =item B<sudb_add>
   
 Takes the following paramaters  Takes the following paramaters
   
Line 597 
Line 660 
   
 and returns true on success or undef otherwise.  and returns true on success or undef otherwise.
   
     $t->sudb_add($suid, 'reg', $cir, $mir, $mac);
   
 You should save_sudb() after calling this, or your changes  will be lost  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
Line 612 
Line 677 
         my $mac  = shift;          my $mac  = shift;
   
         if ($suid =~ /\D/) {          if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                 return undef;                  return undef;
         }          }
   
         unless (lc($type) eq 'reg' || lc($type) eq 'pr') {          unless (lc($type) eq 'reg' || lc($type) eq 'pr') {
                 warn "Invalid type '$type'!";                  $self->last_error("Invalid type '$type'");
                 return undef;                  return undef;
         }          }
   
         if ($cir =~ /\D/) {          if ($cir =~ /\D/) {
                 warn "Invalid CIR '$cir'!";                  $self->last_error("Invalid CIR '$cir'");
                 return undef;                  return undef;
         }          }
   
         if ($mir =~ /\D/) {          if ($mir =~ /\D/) {
                 warn "Invalid MIR '$mir'!";                  $self->last_error("Invalid MIR '$mir'");
                 return undef;                  return undef;
         }          }
   
         my $new_mac = $mac;          my $new_mac = $mac;
         $new_mac =~ s/[^0-9A-Fa-f]//;          $new_mac =~ s/[^0-9A-Fa-f]//;
         unless (length $new_mac == 12) {          unless (length $new_mac == 12) {
                 warn "Invalid MAC '$mac'!";                  $self->last_error("Invalid MAC '$mac'");
                 return undef;                  return undef;
         }          }
         $new_mac = join ' ', $new_mac =~ /../g;          $new_mac = join ' ', $new_mac =~ /../g;
Line 651 
Line 717 
   
 =pod  =pod
   
 =item sudb_delete  =item B<sudb_delete>
   
 Takes either 'all' or the  suid of the su to delete  Takes either 'all' or the  suid of the su to delete
 and returns true on success or undef otherwise.  and returns true on success or undef otherwise.
   
     $t->sudb_delete($suid);
   
 You should save_sudb() after calling this, or your changes  will be lost  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
Line 666 
Line 734 
         my $self = shift;          my $self = shift;
         my $suid = shift;          my $suid = shift;
   
         if (lc($suid) ne 'all' || $suid =~ /\D/) {          #if (lc($suid) ne 'all' || $suid =~ /\D/) {
           if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                 return undef;                  return undef;
         }          }
   
Line 675 
Line 745 
   
 =pod  =pod
   
 =item sudb_modify  =item B<sudb_modify>
   
 Takes either the  suid of the su to delete  Takes either the  suid of the su to change
 as well as what you are changing, either "cir, mir or su2su"  as well as what you are changing, either "cir, mir or su2su"
 and returns true on success or undef otherwise.  and returns true on success or undef otherwise.
   
Line 685 
Line 755 
   
 su2su takes a group id parameter that is in hex.  su2su takes a group id parameter that is in hex.
   
     $t->sudb_modify($suid, 'cir', 512);
   
 You should save_sudb() after calling this, or your changes  will be lost  You should save_sudb() after calling this, or your changes  will be lost
 when the AP is rebooted.  when the AP is rebooted.
   
Line 698 
Line 770 
         my $value = shift;          my $value = shift;
   
         if ($suid =~ /\D/) {          if ($suid =~ /\D/) {
                   $self->last_error("Invalid suid '$suid'");
                 return undef;                  return undef;
         }          }
   
         if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {          if (lc($opt) eq 'cir' or lc($opt) eq 'mir') {
                 if ($value =~ /\D/) {                  if ($value =~ /\D/) {
                           $self->last_error("Invalid $opt '$value'");
                         return undef;                          return undef;
                 }                  }
         } elsif (lc($opt) eq 'su2su') {          } elsif (lc($opt) eq 'su2su') {
                 if ($value =~ /[^0-9A-Za-f]/) {                  if ($value =~ /[^0-9A-Za-f]/) {
                           $self->last_error("Invalid MAC '$value'");
                         return undef;                          return undef;
                 }                  }
         } else {          } else {
                   $self->last_error("Invalid option '$opt'");
                 return undef;                  return undef;
         }          }
   
Line 720 
Line 796 
   
 =pod  =pod
   
 =item enable_tftpd  =item B<enable_tftpd>
   
   - enable the TFTP server
   
 runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing  runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
   
 =cut  =cut
Line 741 
Line 819 
   
 =pod  =pod
   
 =item disable_tftpd  =item B<disable_tftpd>
   
   - disable the TFTP server
   
 runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'  runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
   
 =cut  =cut
Line 762 
Line 842 
   
 =pod  =pod
   
 =item cmd  =item B<cmd>
   
   - runs a command on the AP.
   
 This does most of the work.  At the heart, it calls Net::Telnet::cmd()  This does most of the work.  At the heart, it calls Net::Telnet::cmd()
 but it also does some special stuff for Trango.  but it also does some special stuff for Trango.
   
 Normally returns the last lines from from the command  Normally returns the last lines from from the command
   
 Also accepts these options:  If you are using this, rather than one of the "easy" methods above,
   you probably want to read through the source of this module to see how
   some of the other commands are called.
   
   In addition to the Net::Telnet::cmd() options, it also accepts these:
   
 I<decode>  I<decode>
   
 - if this is true, then it will send the output lines to _decode_lines()  - if this is true, then it will send the output lines to _decode_lines()
 and then returns the decoded output  and then returns the decoded output
   
   I<no_prompt>
   
   - if this is true, it does not wait for a prompt, so you are not stuck
   waiting for something that will never happen.
   
 I<cmd_disconnects>  I<cmd_disconnects>
   
 - if this is true, it then sets logged_in() to false, then it will  - if this is true, it then sets logged_in() to false, then it will
 close() the connection and then sets is_connected() to false  close() the connection and set is_connected() to false
   
 I<expect>  I<expect>
   
 - if this is set (usually to 'Success.') it will check for that in the  - 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  last line of output and if it does not, will return undef because the
 command probably failed  command probably failed
   
 I<args>  I<args>
   
 - a string containing the command line options that are passed to the  - a string containing the command line options that are passed to the
 command  command
   
           $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 );
   
 =cut  =cut
   
 sub cmd  sub cmd
Line 817 
Line 914 
   $cfg{'Timeout'} ||= $self->Timeout;    $cfg{'Timeout'} ||= $self->Timeout;
   
   unless ($cfg{'String'}) {    unless ($cfg{'String'}) {
     #$! = "No command passed";      $self->last_error("No command passed");
     #warn "No command passed\n";  
     return undef;      return undef;
   }    }
   
   unless ($self->is_connected) {    unless ($self->is_connected) {
     #$! = "Not connected";      $self->last_error("Not connected");
     #warn "Not connected\n";  
     return undef;      return undef;
   }    }
   
   unless ($self->logged_in) {    unless ($self->logged_in) {
     #$! = "Not logged in";      $self->last_error("Not logged in");
     #warn "Not logged in\n";  
     return undef;      return undef;
   }    }
   
Line 885 
Line 979 
       return @lines;        return @lines;
     }      }
   } else {    } else {
     #$! = "Error with command ($cfg{'string'}): $last";      $self->last_error("Error with command ($cfg{'String'}): $last");
     return undef;      return undef;
   }    }
 }  }
Line 1059 
Line 1153 
   
 =head1 SEE ALSO  =head1 SEE ALSO
   
 Trango Documentation -  Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm
 http://www.trangobroadband.com/support/product_docs.htm  
   
 L<Net::Telnet>  L<Net::Telnet>
   
Line 1081 
Line 1174 
   
 =head1 COPYRIGHT AND LICENSE  =head1 COPYRIGHT AND LICENSE
   
 Copyright (C) 2005 by Andrew Fresh  Copyright (C) 2005,2006,2007 by Andrew Fresh
   
 This library is free software; you can redistribute it and/or modify  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,  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.  at your option, any later version of Perl 5 you may have available.
   
   
 =cut  =cut
Legend:
Removed from v.1.22  
changed lines
  Added in v.1.26
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>