=================================================================== RCS file: /cvs/trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm,v retrieving revision 1.20 retrieving revision 1.28 diff -u -r1.20 -r1.28 --- trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2006/09/12 03:20:39 1.20 +++ trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/02/01 17:10:07 1.28 @@ -1,5 +1,5 @@ package Net::Telnet::Trango; -# $RedRiver: Trango.pm,v 1.19 2006/09/12 02:16:43 andrew Exp $ +# $RedRiver: Trango.pm,v 1.27 2007/01/31 18:53:29 mike Exp $ use strict; use warnings; use base 'Net::Telnet'; @@ -8,19 +8,20 @@ =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 use Net::Telnet::Trango; my $t = new Net::Telnet::Trango ( Timeout => 5 ); - + $t->open( Host => $fox ) or die "Error connecting: $!"; $t->login('password') or die "Couldn't log in: $!"; - + # Do whatever - + $t->exit; $t->close; @@ -37,6 +38,10 @@ None +=head1 METHODS + +=over + =cut our $VERSION = '0.01'; @@ -48,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 @@ -160,64 +171,76 @@ =pod -=head1 METHODS +=back =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 B + +- 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 @@ -230,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' }, @@ -314,6 +356,7 @@ eth_link => { String => 'eth link', expect => $success }, su_info => { String => 'su info', decode => 'all', expect => $success }, save_ss => { String => 'save ss', expect => $success }, + opmode => { decode => 'all', expect => $success }, # eth r, w and reset??? #su password??? #_bootloader @@ -324,18 +367,19 @@ my %ALIASES = ( bye => 'exit', restart => 'reboot', + Host => 'host', ); my %ACCESS = map { $_ => 1 } qw( firmware_version host_type - Host is_connected logged_in login_banner Timeout last_lines last_vals + last_error ); sub AUTOLOAD @@ -368,8 +412,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() @@ -381,7 +427,7 @@ my $self = shift; unless ( $self->SUPER::open(@_) ) { - #$! = "Couldn't connect to " . $self->Host . ": $!"; + $self->last_error("Couldn't connect to " . $self->host . ": $!"); return undef; } @@ -390,8 +436,8 @@ -match => '/password: ?$/i', -errmode => "return", ) ) { - #$! = "problem connecting to host (" . $self->Host . "): " . - # $self->lastline; + $self->last_error("problem connecting to host (" . $self->host . "): " . + $self->lastline); return undef; } @@ -404,8 +450,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 @@ -426,7 +474,7 @@ -match => $self->prompt, -errmode => "return", ) ) { - #$! = "login ($self->Host) failed: " . $self->lastline; + $self->last_error("login ($self->host) failed: " . $self->lastline); return undef; } @@ -437,8 +485,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() @@ -455,9 +506,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); @@ -467,25 +521,25 @@ =pod -=item su_password +=item B -C +- 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 { my $self = shift; - my $su = shift || '!'; my $new_pass = shift || ''; + my $su = shift || 'all'; - unless (defined $su) { - warn "No su passed!" - #return undef; - } - unless (defined $new_pass) { - warn "No new password!" + $self->last_error("No new password"); #return undef; } @@ -499,10 +553,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 @@ -514,10 +573,22 @@ my $new_subnet = shift; my $new_gateway = shift; - return undef unless $suid =~ /^\d+$/; - return undef unless $new_ip; - return undef unless $new_subnet; - return undef unless $new_gateway; + if ($suid =~ /\D/) { + $self->last_error("Invalid suid '$suid'"); + return undef; + } + 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 return $self->cmd(String => 'su ipconfig ' . @@ -531,15 +602,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 @@ -552,7 +620,7 @@ return undef unless @lines; unless ($PRIVATE{'Decode'}) { - return @lines; + return \@lines; } my @sus; @@ -579,7 +647,7 @@ =pod -=item sudb_add +=item B Takes the following paramaters @@ -591,6 +659,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. @@ -606,28 +676,29 @@ my $mac = shift; if ($suid =~ /\D/) { + $self->last_error("Invalid suid '$suid'"); return undef; } unless (lc($type) eq 'reg' || lc($type) eq 'pr') { - warn "Invalid type '$type'!"; + $self->last_error("Invalid type '$type'"); return undef; } if ($cir =~ /\D/) { - warn "Invalid CIR '$cir'!"; + $self->last_error("Invalid CIR '$cir'"); return undef; } if ($mir =~ /\D/) { - warn "Invalid MIR '$mir'!"; + $self->last_error("Invalid MIR '$mir'"); return undef; } my $new_mac = $mac; $new_mac =~ s/[^0-9A-Fa-f]//; unless (length $new_mac == 12) { - warn "Invalid MAC '$mac'!"; + $self->last_error("Invalid MAC '$mac'"); return undef; } $new_mac = join ' ', $new_mac =~ /../g; @@ -645,11 +716,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. @@ -660,7 +733,9 @@ my $self = 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; } @@ -669,9 +744,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. @@ -679,6 +754,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. @@ -692,18 +769,22 @@ my $value = shift; if ($suid =~ /\D/) { + $self->last_error("Invalid suid '$suid'"); return undef; } if (lc($opt) eq 'cir' or lc($opt) eq 'mir') { if ($value =~ /\D/) { + $self->last_error("Invalid $opt '$value'"); return undef; } } elsif (lc($opt) eq 'su2su') { if ($value =~ /[^0-9A-Za-f]/) { + $self->last_error("Invalid MAC '$value'"); return undef; } } else { + $self->last_error("Invalid option '$opt'"); return undef; } @@ -714,8 +795,10 @@ =pod -=item enable_tftpd +=item B +- enable the TFTP server + runs C 'on')> and makes sure that Tftpd is now 'listen'ing =cut @@ -735,8 +818,10 @@ =pod -=item disable_tftpd +=item B +- disable the TFTP server + runs C 'off')> and makes sure that Tftpd is now 'disabled' =cut @@ -756,32 +841,49 @@ =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 @@ -811,20 +913,17 @@ $cfg{'Timeout'} ||= $self->Timeout; unless ($cfg{'String'}) { - #$! = "No command passed"; - #warn "No command passed\n"; + $self->last_error("No command passed"); return undef; } unless ($self->is_connected) { - #$! = "Not connected"; - #warn "Not connected\n"; + $self->last_error("Not connected"); return undef; } unless ($self->logged_in) { - #$! = "Not logged in"; - #warn "Not logged in\n"; + $self->last_error("Not logged in"); return undef; } @@ -876,10 +975,10 @@ if ($PRIVATE{'Decode'} && $cfg{'decode'}) { return $vals; } else { - return @lines; + return \@lines; } } else { - #$! = "Error with command ($cfg{'string'}): $last"; + $self->last_error("Error with command ($cfg{'String'}): $last"); return undef; } } @@ -894,6 +993,7 @@ my $key = ''; my $val = undef; + my @vals; my $in_key = 0; my $in_val = 1; @@ -918,7 +1018,7 @@ $key =~ s/^\s+//; $key =~ s/\s+$//; - if (defined $val) { + if ($val) { $val =~ s/^\s+//; $val =~ s/\s+$//; } @@ -930,11 +1030,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; @@ -950,7 +1052,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; @@ -1053,8 +1168,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 @@ -1075,11 +1189,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