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