| version 1.4, 2005/12/30 20:26:41 |
version 1.15, 2006/09/07 03:59:03 |
|
|
| package Net::Telnet::Trango;
|
package Net::Telnet::Trango; |
| # $RedRiver: Trango.pm,v 1.3 2005/12/30 19:26:06 andrew Exp $
|
# $RedRiver: Trango.pm,v 1.14 2006/09/07 02:49:34 andrew Exp $ |
| use strict;
|
use strict; |
| use warnings;
|
use warnings; |
| use base 'Net::Telnet';
|
use base 'Net::Telnet'; |
|
|
|
| =pod
|
=pod |
|
|
|
| =head1 NAME
|
=head1 NAME |
|
|
|
| Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface
|
Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface |
|
|
|
| =head1 SYNOPSIS
|
=head1 SYNOPSIS |
|
|
|
| use Net::Telnet::Trango;
|
use Net::Telnet::Trango; |
| my $t = new Net::Telnet::Trango ( Timeout => 5 );
|
my $t = new Net::Telnet::Trango ( Timeout => 5 ); |
|
|
|
| my ($type, $version) = $t->open( Host => $fox );
|
$t->open( Host => $fox ) or die "Error connecting: $!"; |
|
|
|
| unless (defined $type && defined $version) {
|
$t->login('password') or die "Couldn't log in: $!"; |
| die "Error connecting: $!";
|
|
| }
|
# Do whatever |
|
|
|
| $t->login('password') or die "Couldn't log in: $!";
|
$t->exit; |
|
|
$t->close; |
| # Do whatever
|
|
|
|
=head1 DESCRIPTION |
| $t->exit;
|
|
| $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 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. |
|
|
|
| Perl access to the telnet interface on Trango Foxes, SUs and APs.
|
=head2 EXPORT |
|
|
|
| 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.
|
None |
|
|
|
| =head2 EXPORT
|
=cut |
|
|
|
| None
|
our $VERSION = '0.01'; |
|
|
|
| =cut
|
my %PRIVATE = ( |
|
|
is_connected => 0, |
| our $VERSION = '0.01';
|
logged_in => 0, |
|
|
); |
| my %PRIVATE = (
|
|
| is_connected => 0,
|
=pod |
| logged_in => 0,
|
|
| );
|
=item new |
|
|
|
| =pod
|
Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt' |
|
|
|
| =item new
|
It also takes an optional parameter 'Decode'. If not defined it |
|
|
defaults to 1, if it is set to 0, it will not decode the output and |
| Same as new from L<Net::Telnet> but has defaults for the trango 'Prompt'
|
instead return an array of the lines that were returned from the |
|
|
command. |
| =cut
|
|
|
|
=cut |
| sub new
|
|
| {
|
sub new |
| my $class = shift;
|
{ |
|
|
my $class = shift; |
| my %args;
|
|
| if (@_ == 1) {
|
my %args; |
| $args{'Host'} = shift;
|
if (@_ == 1) { |
| } else {
|
$args{'Host'} = shift; |
| %args = @_;
|
} else { |
| }
|
%args = @_; |
|
|
} |
| $args{'Prompt'} ||= '/#> *$/';
|
|
|
|
$args{'Prompt'} ||= '/#> *$/'; |
| foreach my $key (keys %args) {
|
|
| $PRIVATE{$key} = $args{$key};
|
foreach my $key (keys %args) { |
| }
|
$PRIVATE{$key} = $args{$key}; |
|
|
} |
| my $self = $class->SUPER::new(%args);
|
$PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'}; |
| bless $self if ref $self;
|
delete $args{'Decode'}; |
|
|
|
| return $self;
|
my $self = $class->SUPER::new(%args); |
| }
|
bless $self if ref $self; |
|
|
|
| # _password <new password> <new password>
|
return $self; |
| # ? [command]
|
} |
| # apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
|
|
| # arp -bcast <on|off>
|
# _password <new password> <new password> |
| # bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
|
# ? [command] |
| # bye
|
# apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]... |
| # cf2cf ap [default|<size>]
|
# arp -bcast <on|off> |
| # date
|
# bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ... |
| # date <month> <day> <year>
|
# bye |
| # freq scantable
|
# cf2cf ap [default|<size>] |
| # freq channeltable
|
# date |
| # freq writescan [<ch#> <h|v>]
|
# date <month> <day> <year> |
| # freq writechannel [<ch#> <freq>] ...
|
# freq scantable |
| # freq <ch #> <h|v>
|
# freq channeltable |
| # help [command]
|
# freq writescan [<ch#> <h|v>] |
| # heater [<on temp> <off temp>]
|
# freq writechannel [<ch#> <freq>] ... |
| # ipconfig [<new ip> <new subnet mask> <new gateway>]
|
# freq <ch #> <h|v> |
| # log [<# of entries, 1..179>]
|
# help [command] |
| # log <sum> <# of entries, 1..179>
|
# heater [<on temp> <off temp>] |
| # logout
|
# ipconfig [<new ip> <new subnet mask> <new gateway>] |
| # opmode [ap [y]]
|
# log [<# of entries, 1..179>] |
| # password
|
# log <sum> <# of entries, 1..179> |
| # ping <ip addr>
|
# logout |
| # polar <h|v>
|
# opmode [ap [y]] |
| # power <setism|setunii> <max|min|<dBm>>
|
# password |
| # reboot
|
# ping <ip addr> |
| # restart
|
# polar <h|v> |
| # remarks [<str>]
|
# power <setism|setunii> <max|min|<dBm>> |
| # rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
|
# reboot |
| # rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
|
# restart |
| # sysinfo
|
# remarks [<str>] |
| # set suid <id>
|
# rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>] |
| # set apid <id>
|
# rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>] |
| # set baseid <id>
|
# sysinfo |
| # set defaultopmode [<ap|su> <min,0..10>]
|
# set suid <id> |
| # set defaultopmode off
|
# set apid <id> |
| # set snmpcomm [<read | write | trap (id or setall)> <str>]
|
# set baseid <id> |
| # set mir [on|off]
|
# set defaultopmode [<ap|su> <min,0..10>] |
| # set mir threshold <kbps>
|
# set defaultopmode off |
| # set rssitarget [<ism|unii> <dBm>]
|
# set snmpcomm [<read | write | trap (id or setall)> <str>] |
| # set serviceradius [<ism | unii> <miles>]
|
# set mir [on|off] |
| # ssrssi <ch #> <h|v>
|
# set mir threshold <kbps> |
| # su [<suid>|all]
|
# set rssitarget [<ism|unii> <dBm>] |
| # su changechannel <all|suid> <ch#> <h|v>
|
# set serviceradius [<ism | unii> <miles>] |
| # su ipconfig <suid> <new ip> <new subnet> <new gateway>
|
# ssrssi <ch #> <h|v> |
| # su [live|poweroff|priority]
|
# su [<suid>|all] |
| # su <ping|info|status> <suid>
|
# su changechannel <all|suid> <ch#> <h|v> |
| # su powerleveling <all|suid>
|
# su ipconfig <suid> <new ip> <new subnet> <new gateway> |
| # su reboot <all|suid>
|
# su [live|poweroff|priority] |
| # su restart <all|suid>
|
# su <ping|info|status> <suid> |
| # su testrflink <all|suid> [r]
|
# su powerleveling <all|suid> |
| # su testrflink <setlen> [64..1600]
|
# su reboot <all|suid> |
| # su testrflink <aptx> [20..100]
|
# su restart <all|suid> |
| # su sw <suid|all> <sw #> <on|off>
|
# su testrflink <all|suid> [r] |
| # sudb [dload | view]
|
# su testrflink <setlen> [64..1600] |
| # sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
|
# su testrflink <aptx> [20..100] |
| # sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
|
# su sw <suid|all> <sw #> <on|off> |
| # sudb delete <all|<suid>>
|
# sudb [dload | view] |
| # sudb modify <suid> <cir|mir> <kbps>
|
# sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex> |
| # sudb modify <suid> <su2su> <group id,hex>
|
# sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex> |
| # sudb view
|
# sudb delete <all|<suid>> |
| # sulog [lastmins | sampleperiod <1..60>]
|
# sudb modify <suid> <cir|mir> <kbps> |
| # sulog [<# of entry,1..18>]
|
# sudb modify <suid> <su2su> <group id,hex> |
| # survey <ism|unii> <time, sec> <h|v>
|
# sudb view |
| # sw [<sw #> <on|off>]
|
# sulog [lastmins | sampleperiod <1..60>] |
| # temp
|
# sulog [<# of entry,1..18>] |
| # tftpd [on|off]
|
# survey <ism|unii> <time, sec> <h|v> |
| # time
|
# sw [<sw #> <on|off>] |
| # time <hour> <min> <sec>
|
# temp |
| # save <mainimage|fpgaimage> <current chksum> <new chksum>
|
# tftpd [on|off] |
| # save <systemsetting|sudb>
|
# time |
| # updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
|
# time <hour> <min> <sec> |
| # updateflash <systemsetting|sudb>
|
# save <mainimage|fpgaimage> <current chksum> <new chksum> |
|
|
# save <systemsetting|sudb> |
| =pod
|
# updateflash <mainimage|fpgaimage> <current chksum> <new chksum> |
|
|
# updateflash <systemsetting|sudb> |
| =head1 METHODS
|
|
|
|
=pod |
| =head2 ACCESSORS
|
|
|
|
=head1 METHODS |
| =over
|
|
|
|
=head2 ACCESSORS |
| =item Host
|
|
|
|
=over |
| returns the name of the host that you are accessing
|
|
|
|
=item Host |
| =item firmware_version
|
|
|
|
returns the name of the host that you are accessing |
| returns the firmware version on the trango if available otherwise undef.
|
|
| Available after a successful open()
|
=item firmware_version |
| This is usually only set internally
|
|
|
|
returns the firmware version on the trango if available otherwise undef. |
| =item host_type
|
Available after a successful open() |
|
|
This is usually only set internally |
| returns the type of host from the login banner for example M5830S or M5300S.
|
|
| Available after a successful open()
|
=item host_type |
| This is usually only set internally
|
|
|
|
returns the type of host from the login banner for example M5830S or M5300S. |
| =item is_connected
|
Available after a successful open() |
|
|
This is usually only set internally |
| returns 1 after a successful open() otherwise undef
|
|
| This is usually only set internally
|
=item is_connected |
|
|
|
| =item logged_in
|
returns 1 after a successful open() otherwise undef |
|
|
This is usually only set internally |
| returns 1 after a successful login() 0 if it failed and undef if
|
|
| login() was never called
|
=item logged_in |
| This is usually only set internally
|
|
|
|
returns 1 after a successful login() 0 if it failed and undef if |
| =item login_banner
|
login() was never called |
|
|
This is usually only set internally |
| returns the banner that is displayed when first connected at login. Only set after a successful open()
|
|
|
|
=item login_banner |
| This is usually only set internally
|
|
|
|
returns the banner that is displayed when first connected at login. Only set after a successful open() |
| =item last_lines
|
|
|
|
This is usually only set internally |
| returns the output from the last cmd() that was run as an array ref
|
|
| This is usually only set internally
|
=item last_lines |
|
|
|
| =back
|
returns the output from the last cmd() that was run as an array ref |
|
|
This is usually only set internally |
| =head2 ALIASES
|
|
|
|
=back |
| =over
|
|
|
|
=head2 ALIASES |
| =item bye
|
|
|
|
=over |
| alias of exit()
|
|
|
|
=item bye |
| =item restart
|
|
|
|
alias of exit() |
| alias of reboot()
|
|
|
|
=item restart |
| =back
|
|
|
|
alias of reboot() |
| =head2 COMMANDS
|
|
|
|
=back |
| 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:
|
|
| C<tftpd(args =E<gt> 'on')> would enable tftpd
|
=head2 COMMANDS |
|
|
|
| =over
|
Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>, as such they accept the same options as C<cmd()>. Specifically they take a named paramater "args", for example: |
|
|
C<tftpd(args =E<gt> 'on')> would enable tftpd |
| =item tftpd
|
|
|
|
=over |
| Returns a hash ref of the decoded output from the command.
|
|
|
|
=item tftpd |
| Also see enable_tftpd() and disable_tftpd() as those check for correct output
|
|
|
|
Returns a hash ref of the decoded output from the command. |
| =item ver
|
|
|
|
Also see enable_tftpd() and disable_tftpd() as those check for correct output |
| Returns a hash ref of the decoded output from the command.
|
|
|
|
=item ver |
| =item sysinfo
|
|
|
|
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 exit
|
|
|
|
Returns a hash ref of the decoded output from the command. |
| exits the command session with the trango and closes the connection
|
|
|
|
=item exit |
| =item reboot
|
|
|
|
exits the command session with the trango and closes the connection |
| reboots the trango and closes the connection
|
|
|
|
=item reboot |
| =item sulog
|
|
|
|
reboots the trango and closes the connection |
| returns an array ref of hashes containing each log line.
|
|
|
|
=item sulog |
| =cut
|
|
|
|
returns an array ref of hashes containing each log line. |
|
|
|
| my $success = 'Success.';
|
=item save_sudb |
| my %COMMANDS = (
|
|
| tftpd => { decode => 'all', expect => $success },
|
returns true on success, undef on failure |
| ver => { decode => 'all' },
|
|
| sysinfo => { decode => 'all', expect => $success },
|
=item syslog |
| updateflash => { decode => 'all', expect => $success },
|
|
| sulog => { decode => 'sulog', expect => $success },
|
returns the output from the syslog command |
| 'exit' => { Prompt => '//', cmd_disconnects => 1 },
|
|
| reboot => { Prompt => '//', cmd_disconnects => 1 },
|
=item pipe |
| #su password???
|
|
| #_bootloader
|
returns the output from the pipe command |
| #temp
|
|
| #heater
|
=item maclist |
| );
|
|
|
|
returns the output from the maclist command |
| my %ALIASES = (
|
|
| bye => 'exit',
|
=item maclist_reset |
| restart => 'reboot',
|
|
| );
|
resets the maclist. No useful output. |
|
|
|
| my %ACCESS = map { $_ => 1 } qw(
|
=item eth_list |
| firmware_version
|
|
| host_type
|
returns the output from the eth list command |
| Host
|
|
| is_connected
|
=cut |
| logged_in
|
|
| login_banner
|
|
| Timeout
|
my $success = 'Success.'; |
| last_lines
|
my %COMMANDS = ( |
| );
|
tftpd => { decode => 'all', expect => $success }, |
|
|
ver => { decode => 'all' }, |
| sub AUTOLOAD
|
sysinfo => { decode => 'all', expect => $success }, |
| {
|
updateflash => { decode => 'all', expect => $success }, |
| my $self = shift;
|
sulog => { decode => 'sulog', expect => $success }, |
|
|
'exit' => { no_prompt => 1, cmd_disconnects => 1 }, |
| my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/
|
reboot => { no_prompt => 1, cmd_disconnects => 1 }, |
| or die "Weird: $AUTOLOAD";
|
save_sudb => { String => 'save sudb', expect => $success }, |
|
|
syslog => { expect => $success }, |
| if (exists $ALIASES{$method}) {
|
'pipe' => { }, # XXX needs a special decode |
| $method = $ALIASES{$method};
|
maclist => { decode => 'maclist' }, |
| return $self->$method(@_);
|
maclist_reset => { String => 'maclist reset', expect => 'done' }, |
| }
|
eth_link => { String => 'eth link', expect => $success }, |
|
|
# eth r, w and reset??? |
| if (exists $COMMANDS{$method}) {
|
#su password??? |
| $method = shift if (@_ == 1);
|
#_bootloader |
| $COMMANDS{$method}{'String'} ||= $method;
|
#temp |
| return $self->cmd(%{ $COMMANDS{$method} }, @_);
|
#heater |
| }
|
); |
|
|
|
| if (exists $ACCESS{$method}) {
|
my %ALIASES = ( |
| my $prev = $PRIVATE{$method};
|
bye => 'exit', |
| ($PRIVATE{$method}) = @_ if @_;
|
restart => 'reboot', |
| return $prev;
|
); |
| }
|
|
|
|
my %ACCESS = map { $_ => 1 } qw( |
| $method = "SUPER::$method";
|
firmware_version |
| return $self->$method(@_);
|
host_type |
| }
|
Host |
|
|
is_connected |
| =pod
|
logged_in |
|
|
login_banner |
| =item open
|
Timeout |
|
|
last_lines |
| 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()
|
last_vals |
|
|
); |
| =cut
|
|
|
|
sub AUTOLOAD |
| sub open
|
{ |
| {
|
my $self = shift; |
| my $self = shift;
|
|
|
|
my ($method) = (our $AUTOLOAD) =~ /^.*::(\w+)$/ |
| unless ( $self->SUPER::open(@_) ) {
|
or die "Weird: $AUTOLOAD"; |
| #$! = "Couldn't connect to " . $self->Host . ": $!";
|
|
| return undef;
|
if (exists $ALIASES{$method}) { |
| }
|
$method = $ALIASES{$method}; |
|
|
return $self->$method(@_); |
| ## Get to login prompt
|
} |
| unless ($self->waitfor(
|
|
| -match => '/password: ?$/i',
|
if (exists $COMMANDS{$method}) { |
| -errmode => "return",
|
$method = shift if (@_ == 1); |
| ) ) {
|
$COMMANDS{$method}{'String'} ||= $method; |
| #$! = "problem connecting to host (" . $self->Host . "): " .
|
return $self->cmd(%{ $COMMANDS{$method} }, @_); |
| # $self->lastline;
|
} |
| return undef;
|
|
| }
|
if (exists $ACCESS{$method}) { |
|
|
my $prev = $PRIVATE{$method}; |
| $self->parse_login_banner($self->lastline);
|
($PRIVATE{$method}) = @_ if @_; |
|
|
return $prev; |
| $self->is_connected(1);
|
} |
|
|
|
| return $self->is_connected;
|
$method = "SUPER::$method"; |
| }
|
return $self->$method(@_); |
|
|
} |
| =pod
|
|
|
|
=pod |
| =item login
|
|
|
|
=item open |
| Calls open() if not already connected, then sends the password and sets logged_in() if successful
|
|
|
|
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() |
| =cut
|
|
|
|
=cut |
| sub login
|
|
| {
|
sub open |
| my $self = shift;
|
{ |
|
|
my $self = shift; |
| unless ($self->is_connected) {
|
|
| $self->open or return undef;
|
unless ( $self->SUPER::open(@_) ) { |
| }
|
#$! = "Couldn't connect to " . $self->Host . ": $!"; |
|
|
return undef; |
| my $password = shift;
|
} |
|
|
|
| $self->print($password);
|
## Get to login prompt |
| unless ($self->waitfor(
|
unless ($self->waitfor( |
| -match => $self->prompt,
|
-match => '/password: ?$/i', |
| -errmode => "return",
|
-errmode => "return", |
| ) ) {
|
) ) { |
| #$! = "login ($self->Host) failed: " . $self->lastline;
|
#$! = "problem connecting to host (" . $self->Host . "): " . |
| return undef;
|
# $self->lastline; |
| }
|
return undef; |
|
|
} |
| $self->logged_in(1);
|
|
|
|
$self->parse_login_banner($self->lastline); |
| return $self->logged_in;
|
|
| }
|
$self->is_connected(1); |
|
|
|
| =pod
|
return $self->is_connected; |
|
|
} |
| =item parse_login_banner
|
|
|
|
=pod |
| Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner()
|
|
|
|
=item login |
| =cut
|
|
|
|
Calls open() if not already connected, then sends the password and sets logged_in() if successful |
| sub parse_login_banner
|
|
| {
|
=cut |
| my $self = shift;
|
|
|
|
sub login |
| if (@_) {
|
{ |
| $self->login_banner(@_);
|
my $self = shift; |
| }
|
|
|
|
unless ($self->is_connected) { |
| my $banner = $self->login_banner;
|
$self->open or return undef; |
|
|
} |
| my ($type, $ver) = $banner =~
|
|
| /Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i;
|
my $password = shift; |
|
|
|
| $self->login_banner($banner);
|
$self->print($password); |
| $self->host_type($type);
|
unless ($self->waitfor( |
| $self->firmware_version($ver);
|
-match => $self->prompt, |
|
|
-errmode => "return", |
| return 1;
|
) ) { |
| }
|
#$! = "login ($self->Host) failed: " . $self->lastline; |
|
|
return undef; |
| =pod
|
} |
|
|
|
| =item enable_tftpd
|
$self->logged_in(1); |
|
|
|
| runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
|
return $self->logged_in; |
|
|
} |
| =cut
|
|
|
|
=pod |
| sub enable_tftpd
|
|
| {
|
=item parse_login_banner |
| my $self = shift;
|
|
|
|
Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner() |
| my $vals = $self->tftpd( args => 'on' );
|
|
|
|
=cut |
| if ($vals->{'Tftpd'} eq 'listen') {
|
|
| return $vals;
|
sub parse_login_banner |
| } else {
|
{ |
| return undef;
|
my $self = shift; |
| }
|
|
| }
|
if (@_) { |
|
|
$self->login_banner(@_); |
| =pod
|
} |
|
|
|
| =item disable_tftpd
|
my $banner = $self->login_banner; |
|
|
|
| runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
|
my ($type, $ver) = $banner =~ |
|
|
/Welcome to Trango Broadband Wireless (\S+)[\s-]+(.+)$/i; |
| =cut
|
|
|
|
$self->login_banner($banner); |
| sub disable_tftpd
|
$self->host_type($type); |
| {
|
$self->firmware_version($ver); |
| my $self = shift;
|
|
|
|
return 1; |
| my $vals = $self->tftpd( args => 'off' );
|
} |
|
|
|
| if (ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled') {
|
=pod |
| return $vals;
|
|
| } else {
|
=item su_password |
| return undef;
|
|
| }
|
C<su_password('all'|suid, 'new_password')> |
| }
|
|
|
|
=cut |
| =pod
|
|
|
|
sub su_password |
| =item cmd
|
{ |
|
|
my $self = shift; |
| This does most of the work. At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango.
|
my $su = shift || '!'; |
|
|
my $new_pass = shift || ''; |
| Normally returns the last lines from from the command
|
|
|
|
unless (defined $su) { |
| Also accepts these options:
|
warn "No su passed!" |
|
|
#return undef; |
| I<decode>
|
} |
| - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output
|
|
|
|
unless (defined $new_pass) { |
| I<cmd_disconnects>
|
warn "No new password!" |
| - if this is true, it then sets logged_in() to false, then it will close() the connection and then sets is_connected() to false
|
#return undef; |
|
|
} |
| 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->cmd(String => 'su password ' . |
|
|
$su . ' ' . |
| I<args>
|
$new_pass . ' ' . |
| - a string containing the command line options that are passed to the command
|
$new_pass, |
|
|
expect => $success, |
| =cut
|
); |
|
|
} |
| sub cmd
|
|
| {
|
=pod |
| my $self = shift;
|
|
|
|
=item su_ipconfig |
| my @valid_net_telnet_opts = qw(
|
|
| String
|
C<su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )> |
| Output
|
|
| Cmd_remove_mode
|
=cut |
| Errmode
|
|
| Input_record_separator
|
sub su_ipconfig |
| Ors
|
{ |
| Output_record_separator
|
my $self = shift; |
| Prompt
|
|
| Rs
|
my $suid = shift; |
| Timeout
|
my $new_ip = shift; |
| );
|
my $new_subnet = shift; |
|
|
my $new_gateway = shift; |
| my %cfg;
|
|
| if (@_ == 2) {
|
return undef unless $suid =~ /^\d+$/; |
| $cfg{'String'} = shift;
|
return undef unless $new_ip; |
| } elsif (@_ > 2) {
|
return undef unless $new_subnet; |
| %cfg = @_;
|
return undef unless $new_gateway; |
| }
|
|
|
|
# su ipconfig <suid> <new ip> <new subnet> <new gateway> |
| $cfg{'Timeout'} ||= $self->Timeout;
|
return $self->cmd(String => 'su ipconfig ' . |
|
|
$suid . ' ' . |
| unless ($cfg{'String'}) {
|
$new_ip . ' ' . |
| #$! = "No command passed";
|
$new_subnet . ' ' . |
| #warn "No command passed\n";
|
$new_gateway, |
| return undef;
|
expect => $success, |
| }
|
); |
|
|
} |
| unless ($self->is_connected) {
|
|
| #$! = "Not connected";
|
=pod |
| #warn "Not connected\n";
|
|
| return undef;
|
=item sudb_view |
| }
|
|
|
|
returns a reference to an array of hashes each containing: |
| unless ($self->logged_in) {
|
|
| #$! = "Not logged in";
|
suid |
| #warn "Not logged in\n";
|
type |
| return undef;
|
cir |
| }
|
mir |
|
|
mac |
|
|
|
| my %cmd;
|
=cut |
| foreach (@valid_net_telnet_opts) {
|
|
| if (exists $cfg{$_}) {
|
sub sudb_view |
| $cmd{$_} = $cfg{$_};
|
{ |
| }
|
my $self = shift; |
| }
|
|
| if ($cfg{'args'}) {
|
my @lines = $self->cmd( String => 'sudb view', expect => $success ); |
| $cmd{'String'} .= ' ' . $cfg{'args'};
|
|
| }
|
return undef unless @lines; |
| my @lines = $self->SUPER::cmd(%cmd);
|
|
|
|
unless ($PRIVATE{'Decode'}) { |
| $self->last_lines(\@lines);
|
return @lines; |
|
|
} |
| my $vals = 1;
|
|
| if ($cfg{'decode'}) {
|
my @sus; |
| if ($cfg{'decode'} eq 'each') {
|
foreach (@lines) { |
| $vals = _decode_each_line(@lines);
|
next unless $_; |
| } elsif ($cfg{'decode'} eq 'sulog') {
|
if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) { |
| $vals = _decode_sulog(@lines);
|
my %s = ( |
| } else {
|
suid => $1, |
| $vals = _decode_lines(@lines);
|
type => $2, |
| }
|
cir => $3, |
| }
|
mir => $4, |
|
|
mac => $5, |
|
|
); |
| my $last = $self->lastline;
|
|
|
|
$s{'mac'} =~ s/\s//g; |
| if ((not $cfg{'expect'}) || $last =~ /$cfg{'expect'}$/) {
|
$s{'mac'} = uc($s{'mac'}); |
| if ($cfg{'cmd_disconnects'}) {
|
|
| $self->logged_in(0);
|
push @sus, \%s; |
| $self->close;
|
} |
| $self->is_connected(0);
|
} |
| }
|
|
|
|
return \@sus; |
| if ($cfg{'decode'}) {
|
} |
| return $vals;
|
|
| } else {
|
=pod |
| return @lines;
|
|
| }
|
=item sudb_add |
| } else {
|
|
| #$! = "Error with command ($cfg{'string'}): $last";
|
Takes the following paramaters |
| return undef;
|
|
| }
|
suid : numeric, |
| }
|
type : (reg|pr) |
|
|
cir : numeric, |
| #=item _decode_lines
|
mir : numeric, |
|
|
mac : Almost any format, it will be reformatted, |
| sub _decode_lines
|
|
| {
|
and returns true on success or undef otherwise. |
| my @lines = @_;
|
|
|
|
You should save_sudb() after calling this, or your changes will be lost |
| my %conf;
|
when the AP is rebooted. |
|
|
|
| my $key = '';
|
=cut |
| my $val = '';
|
|
| my $in_key = 0;
|
sub sudb_add |
| my $in_val = 0;
|
{ |
|
|
my $self = shift; |
| foreach my $line (@lines) {
|
my $suid = shift; |
| next if $line =~ /$success$/;
|
my $type = shift; |
|
|
my $cir = shift; |
| my @chars = split //, $line;
|
my $mir = shift; |
|
|
my $mac = shift; |
| my $last_key = '';
|
|
| foreach my $c (@chars) {
|
if ($suid =~ /\D/) { |
|
|
return undef; |
| if ($c eq '[' || $c eq "\r" || $c eq "\n") {
|
} |
| if ($c eq '[') {
|
|
| $in_key = 1;
|
unless (lc($type) eq 'reg' || lc($type) eq 'pr') { |
| $in_val = 0;
|
warn "Invalid type '$type'!"; |
| } else {
|
return undef; |
| $in_key = 0;
|
} |
| $in_val = 0;
|
|
| }
|
if ($cir =~ /\D/) { |
|
|
warn "Invalid CIR '$cir'!"; |
| if ($key) {
|
return undef; |
| $key =~ s/^\s+//;
|
} |
| $key =~ s/\s+$//;
|
|
|
|
if ($mir =~ /\D/) { |
| $val =~ s/^\s+//;
|
warn "Invalid MIR '$mir'!"; |
| $val =~ s/\s+$//;
|
return undef; |
|
|
} |
| if ($key eq 'Checksum' && $last_key) {
|
|
| # Special case for these bastids.
|
my $new_mac = $mac; |
| my $new = $last_key;
|
$new_mac =~ s/[^0-9A-Fa-f]//; |
| $new =~ s/\s+\S+$//;
|
unless (length $new_mac == 12) { |
| $key = $new . " " . $key;
|
warn "Invalid MAC '$mac'!"; |
| }
|
return undef; |
|
|
} |
| $last_key = $key;
|
$new_mac = join ' ', $new_mac =~ /../g; |
| $conf{$key} = $val;
|
|
| $key = '';
|
my $string = 'sudb add ' . |
| $val = '';
|
$suid . ' ' . |
| }
|
$type . ' ' . |
|
|
$cir . ' ' . |
| } elsif ($c eq ']') {
|
$mir . ' ' . |
| $in_val = 1;
|
$new_mac; |
| $in_key = 0;
|
|
| $c = shift @chars;
|
|
|
|
return $self->cmd( String => $string, expect => $success ); |
| } elsif ($in_key) {
|
} |
| $key .= $c;
|
|
|
|
=pod |
| } elsif ($in_val) {
|
|
| $val .= $c;
|
=item sudb_delete |
| }
|
|
| }
|
Takes either 'all' or the suid of the su to delete |
| }
|
and returns true on success or undef otherwise. |
|
|
|
| if (%conf) {
|
You should save_sudb() after calling this, or your changes will be lost |
| return \%conf;
|
when the AP is rebooted. |
| } else {
|
|
| return undef;
|
=cut |
| }
|
|
| }
|
sub sudb_delete |
|
|
{ |
| #=item _decode_each_line
|
my $self = shift; |
|
|
my $suid = shift; |
| sub _decode_each_line
|
|
| {
|
if (lc($suid) ne 'all' || $suid =~ /\D/) { |
| my @lines = @_;
|
return undef; |
| my @decoded;
|
} |
| foreach my $line (@lines) {
|
|
| my $decoded = _decode_lines($line);
|
return $self->cmd( String => 'sudb delete ' . $suid, expect => $success ); |
| push @decoded, $decoded if defined $decoded;
|
} |
| }
|
|
| return \@decoded;
|
=pod |
| }
|
|
|
|
=item sudb_modify |
| #=item _decode_sulog
|
|
|
|
Takes either the suid of the su to delete |
| sub _decode_sulog
|
as well as what you are changing, either "cir, mir or su2su" |
| {
|
and returns true on success or undef otherwise. |
| my @lines = @_;
|
|
| my @decoded;
|
cir and mir also take a value to set the cir/mir to. |
| my $last_tm;
|
|
| foreach my $line (@lines) {
|
su2su takes a group id parameter that is in hex. |
| my $decoded = _decode_lines($line);
|
|
|
|
You should save_sudb() after calling this, or your changes will be lost |
| if (defined $decoded) {
|
when the AP is rebooted. |
| if ($decoded->{'tm'}) {
|
|
| $last_tm = $decoded->{'tm'};
|
=cut |
| next;
|
|
| } else {
|
sub sudb_modify |
| $decoded->{'tm'} = $last_tm;
|
{ |
| }
|
my $self = shift; |
| next unless $last_tm;
|
my $suid = shift; |
|
|
my $opt = shift; |
| push @decoded, $decoded if defined $decoded;
|
my $value = shift; |
| }
|
|
| }
|
if ($suid =~ /\D/) { |
| return \@decoded;
|
return undef; |
| }
|
} |
|
|
|
| 1;
|
if (lc($opt) eq 'cir' or lc($opt) eq 'mir') { |
| __END__
|
if ($value =~ /\D/) { |
|
|
return undef; |
| =back
|
} |
|
|
} elsif (lc($opt) eq 'su2su') { |
| =head1 SEE ALSO
|
if ($value =~ /[^0-9A-Za-f]/) { |
|
|
return undef; |
| Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm
|
} |
|
|
} else { |
| L<Net::Telnet>
|
return undef; |
|
|
} |
| =head1 TODO
|
|
|
|
my $string = 'sudb modify ' . $suid . ' ' . $opt . ' ' . $value; |
| 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.
|
|
|
|
return $self->cmd( String => $string, expect => $success ); |
| 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
|
=pod |
|
|
|
| Andrew Fresh E<lt>andrew@rraz.netE<gt>
|
=item enable_tftpd |
|
|
|
| =head1 COPYRIGHT AND LICENSE
|
runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing |
|
|
|
| Copyright (C) 2005 by Andrew Fresh
|
=cut |
|
|
|
| This library is free software; you can redistribute it and/or modify
|
sub enable_tftpd |
| 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.
|
my $self = shift; |
|
|
|
|
|
my $vals = $self->tftpd( args => 'on' ); |
| =cut
|
|
| |
if ($vals->{'Tftpd'} eq 'listen') { |
| |
return $vals; |
| |
} else { |
| |
return undef; |
| |
} |
| |
} |
| |
|
| |
=pod |
| |
|
| |
=item disable_tftpd |
| |
|
| |
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 undef; |
| |
} |
| |
} |
| |
|
| |
=pod |
| |
|
| |
=item cmd |
| |
|
| |
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: |
| |
|
| |
I<decode> |
| |
- if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output |
| |
|
| |
I<cmd_disconnects> |
| |
- if this is true, it then sets logged_in() to false, then it will close() the connection and then sets 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 |
| |
|
| |
=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'}) { |
| |
#$! = "No command passed"; |
| |
#warn "No command passed\n"; |
| |
return undef; |
| |
} |
| |
|
| |
unless ($self->is_connected) { |
| |
#$! = "Not connected"; |
| |
#warn "Not connected\n"; |
| |
return undef; |
| |
} |
| |
|
| |
unless ($self->logged_in) { |
| |
#$! = "Not logged in"; |
| |
#warn "Not logged in\n"; |
| |
return undef; |
| |
} |
| |
|
| |
|
| |
my %cmd; |
| |
foreach (@valid_net_telnet_opts) { |
| |
if (exists $cfg{$_}) { |
| |
$cmd{$_} = $cfg{$_}; |
| |
} |
| |
} |
| |
if ($cfg{'args'}) { |
| |
$cmd{'String'} .= ' ' . $cfg{'args'}; |
| |
} |
| |
my @lines; |
| |
unless ($cfg{'no_prompt'}) { |
| |
@lines = $self->SUPER::cmd(%cmd); |
| |
} else { |
| |
$self->print($cmd{'String'}); |
| |
@lines = $self->lastline; |
| |
} |
| |
|
| |
$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 { |
| |
#$! = "Error with command ($cfg{'string'}): $last"; |
| |
return undef; |
| |
} |
| |
} |
| |
|
| |
#=item _decode_lines |
| |
|
| |
sub _decode_lines |
| |
{ |
| |
my @lines = @_; |
| |
|
| |
my %conf; |
| |
|
| |
my $key = ''; |
| |
my $val = ''; |
| |
my $in_key = 0; |
| |
my $in_val = 0; |
| |
|
| |
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 = 0; |
| |
} |
| |
|
| |
if ($key) { |
| |
$key =~ s/^\s+//; |
| |
$key =~ s/\s+$//; |
| |
|
| |
$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; |
| |
} |
| |
|
| |
$last_key = $key; |
| |
$conf{$key} = $val; |
| |
$key = ''; |
| |
$val = ''; |
| |
} |
| |
|
| |
} elsif ($c eq ']') { |
| |
$in_val = 1; |
| |
$in_key = 0; |
| |
$c = shift @chars; |
| |
|
| |
} elsif ($in_key) { |
| |
$key .= $c; |
| |
|
| |
} elsif ($in_val) { |
| |
$val .= $c; |
| |
} |
| |
} |
| |
} |
| |
|
| |
if (%conf) { |
| |
return \%conf; |
| |
} else { |
| |
return undef; |
| |
} |
| |
} |
| |
|
| |
#=item _decode_each_line |
| |
|
| |
sub _decode_each_line |
| |
{ |
| |
my @lines = @_; |
| |
my @decoded; |
| |
foreach my $line (@lines) { |
| |
my $decoded = _decode_lines($line); |
| |
push @decoded, $decoded if defined $decoded; |
| |
} |
| |
return \@decoded; |
| |
} |
| |
|
| |
#=item _decode_sulog |
| |
|
| |
sub _decode_sulog |
| |
{ |
| |
my @lines = @_; |
| |
my @decoded; |
| |
my $last_tm; |
| |
foreach my $line (@lines) { |
| |
my $decoded = _decode_lines($line); |
| |
|
| |
if (defined $decoded) { |
| |
if ($decoded->{'tm'}) { |
| |
$last_tm = $decoded->{'tm'}; |
| |
next; |
| |
} else { |
| |
$decoded->{'tm'} = $last_tm; |
| |
} |
| |
next unless $last_tm; |
| |
|
| |
push @decoded, $decoded if defined $decoded; |
| |
} |
| |
} |
| |
return \@decoded; |
| |
} |
| |
|
| |
#=item _decode_maclist |
| |
|
| |
sub _decode_maclist |
| |
{ |
| |
my @lines = @_; |
| |
my @decoded; |
| |
my $total_entries = 0; |
| |
my $current_tm = 0; |
| |
foreach my $line (@lines) { |
| |
$line =~ s/\r?\n$//; |
| |
my ($mac, $loc, $tm) = $line =~ / |
| |
([0-9a-fA-F ]{17})\s+ |
| |
(.*)\s+ |
| |
tm\s+ |
| |
(\d+) |
| |
/x; |
| |
|
| |
if ($mac) { |
| |
$mac =~ s/\s+//g; |
| |
$loc =~ s/^\s+//; |
| |
$loc =~ s/\s+$//; |
| |
|
| |
my $suid = undef; |
| |
if ($loc =~ /suid\s+=\s+(\d+)/) { |
| |
$suid = $1; |
| |
$loc = undef; |
| |
} |
| |
|
| |
push @decoded, { |
| |
mac => $mac, |
| |
loc => $loc, |
| |
tm => $tm, |
| |
suid => $suid, |
| |
}; |
| |
} elsif ($line =~ /(\d+)\s+entries/) { |
| |
$total_entries = $1; |
| |
} elsif ($line =~ /current tm = (\d+)\s+sec/) { |
| |
$current_tm = $1 |
| |
} |
| |
} |
| |
|
| |
map { $_->{'cur_tm'} = $current_tm } @decoded; |
| |
|
| |
if (scalar @decoded == $total_entries) { |
| |
return \@decoded; |
| |
} else { |
| |
# XXX we should have a way to set last error, not sure why we don't |
| |
return undef; |
| |
} |
| |
} |
| |
|
| |
1; |
| |
__END__ |
| |
|
| |
=back |
| |
|
| |
=head1 SEE ALSO |
| |
|
| |
Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm |
| |
|
| |
L<Net::Telnet> |
| |
|
| |
=head1 TODO |
| |
|
| |
There are still a lot of commands that are not accessed directly. If you call them (as cmd("command + args") or whatever) and it works, please send me examples that work and I will try to get it incorporated into the next version of the script. |
| |
|
| |
I also want to be able to parse the different types of output from commands like su, sudb all and anything else that would be better available as a perl datastructure. |
| |
|
| |
=head1 AUTHOR |
| |
|
| |
Andrew Fresh E<lt>andrew@rraz.netE<gt> |
| |
|
| |
=head1 COPYRIGHT AND LICENSE |
| |
|
| |
Copyright (C) 2005 by Andrew Fresh |
| |
|
| |
This library is free software; you can redistribute it and/or modify |
| |
it under the same terms as Perl itself, either Perl version 5.8.7 or, |
| |
at your option, any later version of Perl 5 you may have available. |
| |
|
| |
|
| |
=cut |
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to Trango.pm CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / trango / Net-Telnet-Trango / lib / Net / Telnet