=================================================================== RCS file: /cvs/trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm,v retrieving revision 1.25 retrieving revision 1.30 diff -u -r1.25 -r1.30 --- trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/01/17 20:48:46 1.25 +++ trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/02/02 17:51:52 1.30 @@ -1,5 +1,5 @@ package Net::Telnet::Trango; -# $RedRiver: Trango.pm,v 1.24 2007/01/17 19:00:51 andrew Exp $ +# $RedRiver: Trango.pm,v 1.29 2007/02/01 17:58:33 andrew Exp $ use strict; use warnings; use base 'Net::Telnet'; @@ -8,7 +8,8 @@ =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 @@ -52,14 +53,20 @@ =pod -=item new +=item B -Same as new from L 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 but sets the default Trango Prompt: +'/#> *$/' + It also takes an optional parameter 'Decode'. If not defined it defaults to 1, if it is set to 0, it will not decode the output and -instead return an array of the lines that were returned from the -command. +instead return a reference to an array of the lines that were returned +from the command. =cut @@ -168,65 +175,72 @@ =head2 ACCESSORS +These are usually only set internally. + =over -=item Host +=item B -returns the name of the host that you are accessing +- returns the firmware version -=item firmware_version +Returns the firmware version if available, otherwise undef. -returns the firmware version on the trango if available otherwise undef. -Available after a successful open() -This is usually only set internally +It should be available after a successful open(). -=item host_type +=item B +- return the type of host you are connected to. + 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 -This is usually only set internally +=item B -=item logged_in +- Status of the connection to host. -returns 1 after a successful login() 0 if it failed and undef if -login() was never called -This is usually only set internally +returns 1 when connected, undef otherwise. -=item login_banner +=item B +- 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 + +- The banner when first connecting to the host. + 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 -=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 -This is usually only set internally +returns, as an array ref, the output from the last cmd() that was run. -=item last_error +=item B -returns the last error reported. Should contain the the last entry in -last_lines +- A text output of the last error that was encountered. +returns the last error reported. Probably contains the last entry in +last_lines. + =back =head2 ALIASES =over -=item bye +=item B -alias of exit() +- alias of L. -=item restart +=item B -alias of reboot() +- alias of L. =back @@ -239,73 +253,92 @@ =over -=item tftpd +=item B -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 -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 -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 -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 -reboots the trango and closes the connection +- reboots the Trango and closes the connection -=item remarks +=item B +- Set or retrieve the remarks. + Takes an optional argument, which sets the 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 -=item save_sudb +- returns an array ref of hashes containing each log +line. -returns true on success, undef on failure +=item B -=item syslog +- returns true on success, undef on failure -returns the output from the syslog command +=item B -=item pipe +- returns the output from the syslog command -returns the output from the pipe command +=item B -=item maclist +- returns the output from the pipe command -returns the output from the maclist command +=item B -=item maclist_reset +- returns the output from the maclist command -resets the maclist. No useful output. +=item B -=item eth_list +- resets the maclist. -returns the output from the eth list command +No useful output. -=item su_info +=item B -You need to pass in args => and it will return the info for that suid. +- returns the output from the eth list command -=item save_ss +=item B -saves the config. Returns 1 on success, undef on failure. +- returns information about the SU. +You need to pass in the $suid and it will return the info for that suid. + + $t->su_info($suid); + +=item B + +- saves the config. + +Returns 1 on success, undef on failure. + =cut -my $success = 'Success.'; +my $success = 'Success\\.'; my %COMMANDS = ( tftpd => { decode => 'all', expect => $success }, ver => { decode => 'all' }, @@ -334,12 +367,12 @@ my %ALIASES = ( bye => 'exit', restart => 'reboot', + Host => 'host', ); my %ACCESS = map { $_ => 1 } qw( firmware_version host_type - Host is_connected logged_in login_banner @@ -347,6 +380,7 @@ last_lines last_vals last_error + Decode ); sub AUTOLOAD @@ -362,9 +396,13 @@ } if (exists $COMMANDS{$method}) { - $COMMANDS{$method}{'String'} ||= $method; - $COMMANDS{$method}{'args'} .= ' ' . shift if (@_ == 1); - return $self->cmd(%{ $COMMANDS{$method} }, @_); + my %cmd; + foreach my $k (keys %{ $COMMANDS{$method} }) { + $cmd{$k} = $COMMANDS{$method}{$k}; + } + $cmd{'String'} ||= $method; + $cmd{'args'} .= ' ' . shift if (@_ == 1); + return $self->cmd(%cmd, @_); } if (exists $ACCESS{$method}) { @@ -379,8 +417,10 @@ =pod -=item open +=item B +- Open a connection to a Trango AP. + 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() @@ -392,8 +432,8 @@ my $self = shift; unless ( $self->SUPER::open(@_) ) { - $self->last_error("Couldn't connect to " . $self->Host . ": $!"); - return undef; + $self->last_error("Couldn't connect to " . $self->host . ": $!"); + return; } ## Get to login prompt @@ -401,9 +441,9 @@ -match => '/password: ?$/i', -errmode => "return", ) ) { - $self->last_error("problem connecting to host (" . $self->Host . "): " . + $self->last_error("problem connecting to host (" . $self->host . "): " . $self->lastline); - return undef; + return; } $self->parse_login_banner($self->lastline); @@ -415,8 +455,10 @@ =pod -=item login +=item B +- Login to the AP. + Calls open() if not already connected, then sends the password and sets logged_in() if successful @@ -427,7 +469,7 @@ my $self = shift; unless ($self->is_connected) { - $self->open or return undef; + $self->open or return; } my $password = shift; @@ -437,8 +479,8 @@ -match => $self->prompt, -errmode => "return", ) ) { - $self->last_error("login ($self->Host) failed: " . $self->lastline); - return undef; + $self->last_error("login ($self->host) failed: " . $self->lastline); + return; } $self->logged_in(1); @@ -448,8 +490,11 @@ =pod -=item parse_login_banner +=item B +- Converts the login_banner to some useful +variables. + 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() @@ -466,9 +511,12 @@ my $banner = $self->login_banner; - my ($type, $ver) = $banner =~ - /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i; + my ($type, $sep1, $subtype, $sep2, $ver) = $banner =~ + /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i; + $type .= $sep1 . $subtype; + $ver = $subtype . $sep2 . $ver; + $self->login_banner($banner); $self->host_type($type); $self->firmware_version($ver); @@ -478,11 +526,15 @@ =pod -=item su_password +=item B -C If no suid is specified, +- 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 sub su_password @@ -493,7 +545,7 @@ unless (defined $new_pass) { $self->last_error("No new password"); - #return undef; + #return; } return $self->cmd(String => 'su password ' . @@ -506,10 +558,15 @@ =pod -=item su_ipconfig +=item B -C +- 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 sub su_ipconfig @@ -523,19 +580,19 @@ if ($suid =~ /\D/) { $self->last_error("Invalid suid '$suid'"); - return undef; + return; } unless ($new_ip) { $self->last_error("no new_ip passed"); - return undef; + return; } unless ($new_subnet) { $self->last_error("no new_subnet passed"); - return undef; + return; } unless ($new_gateway) { $self->last_error("no new_gateway passed"); - return undef; + return; } # su ipconfig @@ -550,15 +607,12 @@ =pod -=item sudb_view +=item B -returns a reference to an array of hashes each containing: +- Returns the output from the sudb view command - suid - type - cir - mir - mac +returns a reference to an array of hashes each containing these keys +'suid', 'type', 'cir', 'mir' and 'mac' =cut @@ -566,16 +620,16 @@ { my $self = shift; - my @lines = $self->cmd( String => 'sudb view', expect => $success ); + my $lines = $self->cmd( String => 'sudb view', expect => $success ) || []; - return undef unless @lines; + return unless @{ $lines }; unless ($PRIVATE{'Decode'}) { - return @lines; + return $lines; } my @sus; - foreach (@lines) { + foreach (@{ $lines }) { next unless $_; if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) { my %s = ( @@ -598,7 +652,7 @@ =pod -=item sudb_add +=item B Takes the following paramaters @@ -610,6 +664,8 @@ 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 when the AP is rebooted. @@ -626,29 +682,29 @@ if ($suid =~ /\D/) { $self->last_error("Invalid suid '$suid'"); - return undef; + return; } unless (lc($type) eq 'reg' || lc($type) eq 'pr') { $self->last_error("Invalid type '$type'"); - return undef; + return; } if ($cir =~ /\D/) { $self->last_error("Invalid CIR '$cir'"); - return undef; + return; } if ($mir =~ /\D/) { $self->last_error("Invalid MIR '$mir'"); - return undef; + return; } my $new_mac = $mac; $new_mac =~ s/[^0-9A-Fa-f]//; unless (length $new_mac == 12) { $self->last_error("Invalid MAC '$mac'"); - return undef; + return; } $new_mac = join ' ', $new_mac =~ /../g; @@ -665,11 +721,13 @@ =pod -=item sudb_delete +=item B Takes either 'all' or the suid of the su to delete 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 when the AP is rebooted. @@ -683,7 +741,7 @@ #if (lc($suid) ne 'all' || $suid =~ /\D/) { if ($suid =~ /\D/) { $self->last_error("Invalid suid '$suid'"); - return undef; + return; } return $self->cmd( String => 'sudb delete ' . $suid, expect => $success ); @@ -691,9 +749,9 @@ =pod -=item sudb_modify +=item B -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" and returns true on success or undef otherwise. @@ -701,6 +759,8 @@ 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 when the AP is rebooted. @@ -715,22 +775,22 @@ if ($suid =~ /\D/) { $self->last_error("Invalid suid '$suid'"); - return undef; + return; } if (lc($opt) eq 'cir' or lc($opt) eq 'mir') { if ($value =~ /\D/) { $self->last_error("Invalid $opt '$value'"); - return undef; + return; } } elsif (lc($opt) eq 'su2su') { if ($value =~ /[^0-9A-Za-f]/) { $self->last_error("Invalid MAC '$value'"); - return undef; + return; } } else { $self->last_error("Invalid option '$opt'"); - return undef; + return; } my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value; @@ -740,8 +800,10 @@ =pod -=item enable_tftpd +=item B +- enable the TFTP server + runs C 'on')> and makes sure that Tftpd is now 'listen'ing =cut @@ -755,14 +817,16 @@ if ($vals->{'Tftpd'} eq 'listen') { return $vals; } else { - return undef; + return; } } =pod -=item disable_tftpd +=item B +- disable the TFTP server + runs C 'off')> and makes sure that Tftpd is now 'disabled' =cut @@ -776,38 +840,55 @@ if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') { return $vals; } else { - return undef; + return; } } =pod -=item cmd +=item B +- runs a command on the AP. + 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 -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 + - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output +I + +- if this is true, it does not wait for a prompt, so you are not stuck +waiting for something that will never happen. + I + - 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 + - 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 I + - a string containing the command line options that are passed to the command + $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); + =cut sub cmd @@ -838,17 +919,17 @@ unless ($cfg{'String'}) { $self->last_error("No command passed"); - return undef; + return; } unless ($self->is_connected) { $self->last_error("Not connected"); - return undef; + return; } unless ($self->logged_in) { $self->last_error("Not logged in"); - return undef; + return; } @@ -861,12 +942,13 @@ if ($cfg{'args'}) { $cmd{'String'} .= ' ' . $cfg{'args'}; } + my @lines; - unless ($cfg{'no_prompt'}) { - @lines = $self->SUPER::cmd(%cmd); - } else { + if ($cfg{'no_prompt'}) { $self->print($cmd{'String'}); @lines = $self->lastline; + } else { + @lines = $self->SUPER::cmd(%cmd); } $self->last_lines(\@lines); @@ -899,11 +981,11 @@ if ($PRIVATE{'Decode'} && $cfg{'decode'}) { return $vals; } else { - return @lines; + return \@lines; } } else { $self->last_error("Error with command ($cfg{'String'}): $last"); - return undef; + return; } } @@ -917,6 +999,7 @@ my $key = ''; my $val = undef; + my @vals; my $in_key = 0; my $in_val = 1; @@ -941,7 +1024,7 @@ $key =~ s/^\s+//; $key =~ s/\s+$//; - if (defined $val) { + if ($val) { $val =~ s/^\s+//; $val =~ s/\s+$//; } @@ -953,11 +1036,13 @@ $key = $new . " " . $key; } - $last_key = $key; $conf{$key} = $val; + $last_key = $key; $key = ''; - $val = ''; - } + } elsif ($val) { + push @vals, $val; + } + $val = ''; } elsif ($c eq ']') { $in_val = 1; @@ -973,7 +1058,20 @@ } } + unless ($key) { + push @vals, $val; + } + + if (@vals == 1) { + $val = $vals[0]; + } elsif (@vals) { + $val= \@vals; + } else { + $val = undef; + } + if (%conf) { + $conf{_pre} = $val if $val; return \%conf; } else { return $val; @@ -1065,7 +1163,7 @@ return \@decoded; } else { # XXX we should have a way to set last error, not sure why we don't - return undef; + return; } } @@ -1076,8 +1174,7 @@ =head1 SEE ALSO -Trango Documentation - -http://www.trangobroadband.com/support/product_docs.htm +Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm L @@ -1098,11 +1195,10 @@ =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 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