| version 1.38, 2007/02/06 16:22:46 |
version 1.55, 2009/07/08 18:00:55 |
|
|
| package Net::Telnet::Trango;
|
package Net::Telnet::Trango; |
|
|
|
| # $RedRiver: Trango.pm,v 1.37 2007/02/05 23:09:59 andrew Exp $
|
# $RedRiver: Trango.pm,v 1.54 2008/10/29 17:34:06 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
|
Net::Telnet::Trango |
| - Perl extension for accessing the Trango telnet interface
|
- Perl extension for accessing the Trango telnet interface |
|
|
|
| =head1 SYNOPSIS
|
=head1 SYNOPSIS |
|
|
|
| use Net::Telnet::Trango;
|
use Net::Telnet::Trango; |
| my $t = new Net::Telnet::Trango ( Timeout => 5 );
|
my $t = new Net::Telnet::Trango ( Timeout => 5 ); |
|
|
|
| $t->open( Host => $fox ) or die "Error connecting: $!";
|
$t->open( Host => $ap ) or die "Error connecting: $!"; |
|
|
|
| $t->login('password') or die "Couldn't log in: $!";
|
$t->login('password') or die "Couldn't log in: $!"; |
|
|
|
| # Do whatever
|
# Do whatever |
|
|
|
| $t->exit;
|
$t->exit; |
| $t->close;
|
$t->close; |
|
|
|
| =head1 DESCRIPTION
|
=head1 DESCRIPTION |
|
|
|
| Perl access to the telnet interface on Trango Foxes, SUs and APs.
|
Perl access to the telnet interface on Trango APs and SUs. |
|
|
|
| Another handy feature is that it will parse the output from certain
|
A handy feature is that it will parse the output from certain commands that is |
| commands that is in the format "[key1] value1 [key2] value2" and put
|
in the format "[key1] value1 [key2] value2" and put those in a hashref that is |
| those in a hashref that is returned. This makes using the output from
|
returned. This makes using the output from things like sysinfo very easy to |
| things like sysinfo very easy to do.
|
do. |
|
|
|
| =head2 EXPORT
|
=head2 EXPORT |
|
|
|
| None
|
None |
|
|
|
| =head1 METHODS
|
=head1 METHODS |
|
|
|
| =cut
|
=cut |
|
|
|
| our $VERSION = '0.01';
|
our $VERSION = '0.01'; |
|
|
|
| my $EMPTY = q{};
|
my $EMPTY = q{}; |
| my $SPACE = q{ };
|
my $SPACE = q{ }; |
|
|
|
| my %PRIVATE = (
|
my %PRIVATE = ( |
| is_connected => 0,
|
is_connected => 0, |
| logged_in => 0,
|
logged_in => 0, |
| );
|
); |
|
|
|
| =pod
|
=pod |
|
|
|
| =head2 B<new> - Creates a new Net::Telnet::Trango object.
|
=head2 B<new> - Creates a new Net::Telnet::Trango object. |
|
|
|
| new([Options from Net::Telnet,]
|
new([Options from Net::Telnet,] |
| [Decode => 0,]);
|
[Decode => 0,]); |
|
|
|
| Same as new from L<Net::Telnet> but sets the default Trango Prompt:
|
Same as new from L<Net::Telnet> but sets the default Trango Prompt: |
| '/#> *$/'
|
'/[\$#]>\s*\Z/' |
|
|
|
| It also takes an optional parameter 'Decode'. If not defined it
|
It also takes an optional parameter 'Decode'. If not defined it |
| defaults to 1, if it is set to 0, it will not decode the output and
|
defaults to 1, if it is set to 0, it will not decode the output and |
| instead return a reference to an array of the lines that were returned
|
instead return a reference to an array of the lines that were returned |
| from the command.
|
from the command. |
|
|
|
| =cut
|
=cut |
|
|
|
| sub new {
|
sub new { |
| my $class = shift;
|
my $class = shift; |
|
|
|
| my %args;
|
my %args; |
| if ( @_ == 1 ) {
|
if ( @_ == 1 ) { |
| $args{'Host'} = shift;
|
$args{'Host'} = shift; |
| }
|
} |
| else {
|
else { |
| %args = @_;
|
%args = @_; |
| }
|
} |
|
|
|
| $args{'Prompt'} ||= '/#> *$/';
|
$args{'Prompt'} ||= '/[\$#]>\s*\r?\n?$/'; |
|
|
|
| foreach my $key ( keys %args ) {
|
foreach my $key ( keys %args ) { |
| $PRIVATE{$key} = $args{$key};
|
$PRIVATE{$key} = $args{$key}; |
| }
|
} |
| $PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'};
|
$PRIVATE{'Decode'} = 1 unless defined $PRIVATE{'Decode'}; |
| delete $args{'Decode'};
|
delete $args{'Decode'}; |
|
|
|
| my $self = $class->SUPER::new(%args);
|
my $self = $class->SUPER::new(%args); |
| bless $self if ref $self;
|
bless $self if ref $self; |
|
|
|
| return $self;
|
return $self; |
| }
|
} |
|
|
|
| # _password <new password> <new password>
|
# _password <new password> <new password> |
| # ? [command]
|
# ? [command] |
| # apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]...
|
# apsearch <secs> <ch#> <h|v> [<ch#> <h|v>]... |
| # arp -bcast <on|off>
|
# arp -bcast <on|off> |
| # bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ...
|
# bcastscant <all|suid> <ch#> <h|v> [<ch#> <h|v> ... |
| # bye
|
# bye |
| # cf2cf ap [default|<size>]
|
# cf2cf ap [default|<size>] |
| # date
|
# date |
| # date <month> <day> <year>
|
# date <month> <day> <year> |
| # freq scantable
|
# freq scantable |
| # freq channeltable
|
# freq channeltable |
| # freq writescan [<ch#> <h|v>]
|
# freq writescan [<ch#> <h|v>] |
| # freq writechannel [<ch#> <freq>] ...
|
# freq writechannel [<ch#> <freq>] ... |
| # freq <ch #> <h|v>
|
# freq <ch #> <h|v> |
| # help [command]
|
# help [command] |
| # heater [<on temp> <off temp>]
|
# heater [<on temp> <off temp>] |
| # ipconfig [<new ip> <new subnet mask> <new gateway>]
|
# ipconfig [<new ip> <new subnet mask> <new gateway>] |
| # log [<# of entries, 1..179>]
|
# linktest <suid> [<pkt len, bytes> [<# of pkts> [<# of cycle>]]] |
| # log <sum> <# of entries, 1..179>
|
# log [<# of entries, 1..179>] |
| # logout
|
# log <sum> <# of entries, 1..179> |
| # opmode [ap [y]]
|
# logout |
| # password
|
# opmode [ap [y]] |
| # ping <ip addr>
|
# password |
| # polar <h|v>
|
# ping <ip addr> |
| # power <setism|setunii> <max|min|<dBm>>
|
# polar <h|v> |
| # reboot
|
# power <setism|setunii> <max|min|<dBm>> |
| # restart
|
# reboot |
| # remarks [<str>]
|
# restart |
| # rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>]
|
# remarks [<str>] |
| # rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>]
|
# rfrxthreshold [<ism|unii> <-90|-85|-80|-75|-70|-65>] |
| # sysinfo
|
# rfrxth [<ism|unii> <-90|-85|-80|-75|-70|-65>] |
| # set suid <id>
|
# sysinfo |
| # set apid <id>
|
# set suid <id> |
| # set baseid <id>
|
# set apid <id> |
| # set defaultopmode [<ap|su> <min,0..10>]
|
# set baseid <id> |
| # set defaultopmode off
|
# set defaultopmode [<ap|su> <min,0..10>] |
| # set snmpcomm [<read | write | trap (id or setall)> <str>]
|
# set defaultopmode off |
| # set mir [on|off]
|
# set snmpcomm [<read | write | trap (id or setall)> <str>] |
| # set mir threshold <kbps>
|
# set mir [on|off] |
| # set rssitarget [<ism|unii> <dBm>]
|
# set mir threshold <kbps> |
| # set serviceradius [<ism | unii> <miles>]
|
# set rssitarget [<ism|unii> <dBm>] |
| # ssrssi <ch #> <h|v>
|
# set serviceradius [<ism | unii> <miles>] |
| # su [<suid>|all]
|
# ssrssi <ch #> <h|v> |
| # su changechannel <all|suid> <ch#> <h|v>
|
# su [<suid>|all] |
| # su ipconfig <suid> <new ip> <new subnet> <new gateway>
|
# su changechannel <all|suid> <ch#> <h|v> |
| # su [live|poweroff|priority]
|
# su ipconfig <suid> <new ip> <new subnet> <new gateway> |
| # su <ping|info|status> <suid>
|
# su [live|poweroff|priority] |
| # su powerleveling <all|suid>
|
# su <ping|info|status> <suid> |
| # su reboot <all|suid>
|
# su powerleveling <all|suid> |
| # su restart <all|suid>
|
# su reboot <all|suid> |
| # su testrflink <all|suid> [r]
|
# su restart <all|suid> |
| # su testrflink <setlen> [64..1600]
|
# su testrflink <all|suid> [r] |
| # su testrflink <aptx> [20..100]
|
# su testrflink <setlen> [64..1600] |
| # su sw <suid|all> <sw #> <on|off>
|
# su testrflink <aptx> [20..100] |
| # sudb [dload | view]
|
# su sw <suid|all> <sw #> <on|off> |
| # sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex>
|
# sudb [dload | view] |
| # sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex>
|
# sudb add <suid> pr <cir,kbps> <mir,kbps> <device id,hex> |
| # sudb delete <all|<suid>>
|
# sudb add <suid> reg <cir,kbps> <mir,kbps> <device id,hex> |
| # sudb modify <suid> <cir|mir> <kbps>
|
# sudb delete <all|<suid>> |
| # sudb modify <suid> <su2su> <group id,hex>
|
# sudb modify <suid> <cir|mir> <kbps> |
| # sudb view
|
# sudb modify <suid> <su2su> <group id,hex> |
| # sulog [lastmins | sampleperiod <1..60>]
|
# sudb view |
| # sulog [<# of entry,1..18>]
|
# sulog [lastmins | sampleperiod <1..60>] |
| # survey <ism|unii> <time, sec> <h|v>
|
# sulog [<# of entry,1..18>] |
| # sw [<sw #> <on|off>]
|
# survey <ism|unii> <time, sec> <h|v> |
| # temp
|
# sw [<sw #> <on|off>] |
| # tftpd [on|off]
|
# temp |
| # time
|
# tftpd [on|off] |
| # time <hour> <min> <sec>
|
# time |
| # save <mainimage|fpgaimage> <current chksum> <new chksum>
|
# time <hour> <min> <sec> |
| # save <systemsetting|sudb>
|
# save <mainimage|fpgaimage> <current chksum> <new chksum> |
| # updateflash <mainimage|fpgaimage> <current chksum> <new chksum>
|
# save <systemsetting|sudb> |
| # updateflash <systemsetting|sudb>
|
# updateflash <mainimage|fpgaimage> <current chksum> <new chksum> |
|
|
# updateflash <systemsetting|sudb> |
| =pod
|
|
|
|
=pod |
| =head1 ACCESSORS
|
|
|
|
=head1 ACCESSORS |
| These are usually only set internally.
|
|
|
|
These are usually only set internally. |
| =head2 B<firmware_version> - returns the firmware version
|
|
|
|
=head2 B<firmware_version> - returns the firmware version |
| Returns the firmware version if available, otherwise undef.
|
|
|
|
Returns the firmware version if available, otherwise undef. |
| It should be available after a successful open().
|
|
|
|
It should be available after a successful open(). |
| =head2 B<host_type> - return the type of host you are connected to.
|
|
|
|
=head2 B<host_type> - return the type of host you are connected to. |
| returns the type of host from the login banner for example M5830S or M5300S.
|
|
|
|
returns the type of host from the login banner for example M5830S or M5300S. |
| Should be available after a successful open().
|
|
|
|
Should be available after a successful open(). |
| =head2 B<is_connected> - Status of the connection to host.
|
|
|
|
=head2 B<is_connected> - Status of the connection to host. |
| returns 1 when connected, undef otherwise.
|
|
|
|
returns 1 when connected, undef otherwise. |
| =head2 B<logged_in> - Status of being logged in to the host.
|
|
|
|
=head2 B<logged_in> - Status of being logged in to the host. |
| returns 1 after a successful login(), 0 if it failed and undef if
|
|
| login() was never called.
|
returns 1 after a successful login(), 0 if it failed and undef if |
|
|
login() was never called. |
| =head2 B<login_banner> - The banner when first connecting to the host.
|
|
|
|
=head2 B<login_banner> - 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().
|
returns the banner that is displayed when first connected at login. |
|
|
Only set after a successful open(). |
| =head2 B<last_lines> - The last lines of output from the last cmd().
|
|
|
|
=head2 B<last_lines> - The last lines of output from the last cmd(). |
| returns, as an array ref, the output from the last cmd() that was run.
|
|
|
|
returns, as an array ref, the output from the last cmd() that was run. |
| =head2 B<last_error> - A text output of the last error that was encountered.
|
|
|
|
=head2 B<last_error> - A text output of the last error that was encountered. |
| returns the last error reported. Probably contains the last entry in
|
|
| last_lines.
|
returns the last error reported. Probably contains the last entry in |
|
|
last_lines. |
| =head1 ALIASES
|
|
|
|
=head1 ALIASES |
| =head2 B<bye> - alias of exit()
|
|
|
|
=head2 B<bye> - alias of exit() |
| Does the same as exit()
|
|
|
|
Does the same as exit() |
| =head2 B<restart> - alias of reboot()
|
|
|
|
=head2 B<restart> - alias of reboot() |
| Does the same as reboot()
|
|
|
|
Does the same as reboot() |
| =head2 B<save_systemsetting> - alias of save_ss()
|
|
|
|
=head2 B<save_systemsetting> - alias of save_ss() |
| Does the same as save_ss()
|
|
|
|
Does the same as save_ss() |
| =head1 COMMANDS
|
|
|
|
=head1 COMMANDS |
| Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>,
|
|
| as such they accept the same options as C<cmd()>.
|
Most of these are just shortcuts to C<cmd(String =E<gt> METHOD)>, |
| Specifically they take a named paramater "args", for example:
|
as such they accept the same options as C<cmd()>. |
| C<tftpd(args =E<gt> 'on')> would enable tftpd
|
Specifically they take a named paramater "args", for example: |
|
|
C<tftpd(args =E<gt> 'on')> would enable tftpd |
| =head2 B<tftpd> - The output from the tftpd command
|
|
|
|
=head2 B<tftpd> - The output from the tftpd command |
| 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 that it was
|
|
| successfully changed.
|
Also see enable_tftpd() and disable_tftpd() as those check that it was |
|
|
successfully changed. |
| =head2 B<ver> - The output from the ver command
|
|
|
|
=head2 B<ver> - The output from the ver command |
| Returns a hash ref of the decoded output from the
|
|
| command.
|
Returns a hash ref of the decoded output from the |
|
|
command. |
| =head2 B<sysinfo> - The output from the sysinfo command
|
|
|
|
=head2 B<sysinfo> - The output from the sysinfo command |
| Returns a hash ref of the decoded output from the
|
|
| command.
|
Returns a hash ref of the decoded output from the |
|
|
command. |
| =head2 B<exit> - Exits the connection
|
|
|
|
=head2 B<exit> - Exits the connection |
| exits the command session with the Trango and closes
|
|
| the connection
|
exits the command session with the Trango and closes |
|
|
the connection |
| =head2 B<reboot> - Sends a reboot command
|
|
|
|
=head2 B<reboot> - Sends a reboot command |
| reboots the Trango and closes the connection
|
|
|
|
reboots the Trango and closes the connection |
| =head2 B<remarks> - Set or retrieve the remarks.
|
|
|
|
=head2 B<remarks> - Set or retrieve the remarks. |
| Takes an optional argument, which sets the remarks.
|
|
| If there is no argument, returns the current remarks.
|
Takes an optional argument, which sets the remarks. |
|
|
If there is no argument, returns the current remarks. |
| my $old_remarks = $t->remarks();
|
|
| $t->remarks($new_remarks);
|
my $old_remarks = $t->remarks(); |
|
|
$t->remarks($new_remarks); |
| =head2 B<sulog> - The output from the sulog command
|
|
|
|
=head2 B<sulog> - The output from the sulog command |
| Returns an array ref of hashes containing each log
|
|
| line.
|
Returns an array ref of hashes containing each log |
|
|
line. |
| =head2 B<save_sudb> - saves the sudb
|
|
|
|
=head2 B<save_sudb> - saves the sudb |
| Returns true on success, undef on failure
|
|
|
|
Returns true on success, undef on failure |
| =head2 B<syslog> - The output from the sulog command
|
|
|
|
=head2 B<syslog> - The output from the sulog command |
| Returns a hashref of the output from the syslog command
|
|
|
|
Returns a hashref of the output from the syslog command |
| =head2 B<pipe> - the pipe command
|
|
|
|
=head2 B<pipe> - the pipe command |
| Returns the output from the pipe command
|
|
|
|
Returns the output from the pipe command |
| =head2 B<maclist> - retrieves the maclist
|
|
|
|
=head2 B<maclist> - retrieves the maclist |
| Returns the output from the maclist command
|
|
|
|
Returns the output from the maclist command |
| =head2 B<maclist_reset> - resets the maclist.
|
|
|
|
=head2 B<maclist_reset> - resets the maclist. |
| No useful output.
|
|
|
|
No useful output. |
| =head2 B<eth_list> - eth list command
|
|
|
|
=head2 B<eth_link> - eth link command |
| Returns the output from the eth list command
|
|
|
|
Returns the output from the eth link command |
|
|
|
| =head2 B<su_info> - gets the su info
|
This command seems to cause some weird issues. It often will cause the |
|
|
command after it to appear to fail. I am not sure why. |
| Returns information about the SU.
|
|
|
|
=head2 B<su_info> - gets the su info |
| You need to pass in the $suid and it will return the info for that suid.
|
|
|
|
Returns information about the SU. |
| $t->su_info($suid);
|
|
|
|
You need to pass in the $suid and it will return the info for that suid. |
| =head2 B<su_testrflink> - tests the RF Link to an su
|
|
|
|
$t->su_info($suid); |
| $t->su_testrflink($suid|'all');
|
|
|
|
=head2 B<su_testrflink> - tests the RF Link to an su |
| =head2 B<save_ss> - saves the config.
|
|
|
|
$t->su_testrflink($suid|'all'); |
| Returns 1 on success, undef on failure.
|
|
|
|
=head2 B<save_ss> - saves the config. |
| =head2 B<opmode> - sets opmode ap y or returns the opmode
|
|
|
|
Returns 1 on success, undef on failure. |
| $t->opmode([ap y]);
|
|
|
|
=head2 B<opmode> - sets opmode ap y or returns the opmode |
| =cut
|
|
|
|
$t->opmode([ap y]); |
| my $success = 'Success\\.';
|
|
| my %COMMANDS = (
|
=cut |
| tftpd => { decode => 'all', expect => $success },
|
|
| ver => { decode => 'all' },
|
my $success = 'Success\\.'; |
| sysinfo => { decode => 'all', expect => $success },
|
my %COMMANDS = ( |
| updateflash => { decode => 'all', expect => $success },
|
_clear => { String => "\n" }, |
| sulog => { decode => 'sulog', expect => $success },
|
tftpd => { decode => 'all', expect => $success }, |
| 'exit' => { no_prompt => 1, cmd_disconnects => 1 },
|
ver => { decode => 'all' }, |
| reboot => { no_prompt => 1, cmd_disconnects => 1 },
|
sysinfo => { decode => 'all', expect => $success }, |
| remarks => { decode => 'all', expect => $success },
|
updateflash => { decode => 'all', expect => $success }, |
| save_sudb => { String => 'save sudb', expect => $success },
|
sulog => { decode => 'sulog', expect => $success }, |
| syslog => { expect => $success },
|
'exit' => { no_prompt => 1, cmd_disconnects => 1 }, |
| 'pipe' => {}, # XXX needs a special decode
|
reboot => { no_prompt => 1, cmd_disconnects => 1 }, |
| maclist => { decode => 'maclist' },
|
remarks => { decode => 'all', expect => $success }, |
| maclist_reset => { String => 'maclist reset', expect => 'done' },
|
save_sudb => { String => 'save sudb', expect => $success }, |
| eth_link => { String => 'eth link', expect => $success },
|
syslog => { expect => $success }, |
| su_info =>
|
'pipe' => {}, # XXX needs a special decode |
| { String => 'su info', decode => 'all', expect => $success },
|
maclist => { decode => 'maclist' }, |
| su_testrflink =>
|
maclist_reset => { String => 'maclist reset', expect => 'done' }, |
| { String => 'su testrflink', decode => 'each', expect => $success },
|
eth_link => { String => 'eth link', expect => $success }, |
| save_ss => { String => 'save ss', expect => $success },
|
su_info => |
| opmode => { decode => 'all', expect => $success },
|
{ String => 'su info', decode => 'all', expect => $success }, |
| );
|
su_testrflink => |
|
|
{ String => 'su testrflink', decode => 'each', expect => $success }, |
| my %ALIASES = (
|
save_ss => { String => 'save ss', expect => $success }, |
| bye => 'exit',
|
opmode => { decode => 'all', expect => $success }, |
| restart => 'reboot',
|
arq => { decode => 'all' }, |
| Host => 'host',
|
); |
| save_systemseting => 'save_ss',
|
|
| );
|
my %ALIASES = ( |
|
|
bye => 'exit', |
| my %ACCESS = map { $_ => 1 } qw(
|
restart => 'reboot', |
| firmware_version
|
Host => 'host', |
| host_type
|
save_systemseting => 'save_ss', |
| is_connected
|
); |
| logged_in
|
|
| login_banner
|
my %ACCESS = map { $_ => 1 } qw( |
| Timeout
|
firmware_version |
| last_lines
|
host_type |
| last_vals
|
is_connected |
| last_error
|
logged_in |
| Decode
|
login_banner |
| );
|
Timeout |
|
|
last_lines |
| sub AUTOLOAD {
|
last_vals |
| my $self = shift;
|
last_error |
|
|
Decode |
| my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/
|
); |
| or die "Weird: $AUTOLOAD";
|
|
|
|
sub AUTOLOAD { |
| if ( exists $ALIASES{$method} ) {
|
my $self = shift; |
| $method = $ALIASES{$method};
|
|
| return $self->$method(@_);
|
my ($method) = ( our $AUTOLOAD ) =~ /^.*::(\w+)$/ |
| }
|
or die "Weird: $AUTOLOAD"; |
|
|
|
| if ( exists $COMMANDS{$method} ) {
|
if ( exists $ALIASES{$method} ) { |
| my %cmd;
|
$method = $ALIASES{$method}; |
| foreach my $k ( keys %{ $COMMANDS{$method} } ) {
|
return $self->$method(@_); |
| $cmd{$k} = $COMMANDS{$method}{$k};
|
} |
| }
|
|
| $cmd{'String'} ||= $method;
|
if ( exists $COMMANDS{$method} ) { |
| $cmd{'args'} .= $SPACE . shift if ( @_ == 1 );
|
my %cmd; |
| return $self->cmd( %cmd, @_ );
|
foreach my $k ( keys %{ $COMMANDS{$method} } ) { |
| }
|
$cmd{$k} = $COMMANDS{$method}{$k}; |
|
|
} |
| if ( exists $ACCESS{$method} ) {
|
$cmd{'String'} ||= $method; |
| my $prev = $PRIVATE{$method};
|
$cmd{'args'} .= $SPACE . shift if ( @_ == 1 ); |
| ( $PRIVATE{$method} ) = @_ if @_;
|
return $self->cmd( %cmd, @_ ); |
| return $prev;
|
} |
| }
|
|
|
|
if ( exists $ACCESS{$method} ) { |
| $method = "SUPER::$method";
|
my $prev = $PRIVATE{$method}; |
| return $self->$method(@_);
|
( $PRIVATE{$method} ) = @_ if @_; |
| }
|
return $prev; |
|
|
} |
| =pod
|
|
|
|
$method = "SUPER::$method"; |
| =head2 B<open> - Open a connection to a Trango AP.
|
return $self->$method(@_); |
|
|
} |
| 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
|
=pod |
| host_type() and firmware_version()
|
|
|
|
=head2 B<open> - Open a connection to a Trango AP. |
| =cut
|
|
|
|
Calls Net::Telnet::open() then makes sure you get a password prompt so |
| sub open {
|
you are ready to login() and parses the login banner so you can get |
| my $self = shift;
|
host_type() and firmware_version() |
|
|
|
| unless ( $self->SUPER::open(@_) ) {
|
=cut |
| $self->last_error( "Couldn't connect to " . $self->host . ": $!" );
|
|
| return;
|
sub open { |
| }
|
my $self = shift; |
|
|
|
| ## Get to login prompt
|
unless ( $self->SUPER::open(@_) ) { |
| unless (
|
$self->last_error( "Couldn't connect to " . $self->host . ": $!" ); |
| $self->waitfor(
|
return; |
| -match => '/password: ?$/i',
|
} |
| -errmode => "return",
|
|
| )
|
## Get to login prompt |
| )
|
unless ( |
| {
|
$self->waitfor( |
| $self->last_error( "problem connecting to host ("
|
-match => '/password: ?$/i', |
| . $self->host . "): "
|
-errmode => "return", |
| . $self->lastline );
|
) |
| return;
|
) |
| }
|
{ |
|
|
$self->last_error( "problem connecting to host (" |
| $self->parse_login_banner( $self->lastline );
|
. $self->host . "): " |
|
|
. $self->lastline ); |
| $self->is_connected(1);
|
return; |
|
|
} |
| return $self->is_connected;
|
|
| }
|
$self->parse_login_banner( $self->lastline ); |
|
|
|
| =pod
|
$self->is_connected(1); |
|
|
|
| =head2 B<login> - Login to the AP.
|
return $self->is_connected; |
|
|
} |
| Calls open() if not already connected, then sends the password and sets
|
|
| logged_in() if successful
|
=pod |
|
|
|
| =cut
|
=head2 B<login> - Login to the AP. |
|
|
|
| sub login {
|
Calls open() if not already connected, then sends the password and sets |
| my $self = shift;
|
logged_in() if successful |
|
|
|
| unless ( $self->is_connected ) {
|
=cut |
| $self->open or return;
|
|
| }
|
sub login { |
|
|
my $self = shift; |
| my $password = shift;
|
|
|
|
unless ( $self->is_connected ) { |
| $self->print($password);
|
$self->open or return; |
| unless (
|
} |
| $self->waitfor(
|
|
| -match => $self->prompt,
|
my $password = shift; |
| -errmode => "return",
|
|
| )
|
$self->print($password); |
| )
|
unless ( |
| {
|
$self->waitfor( |
| $self->last_error( "login ($self->host) failed: " . $self->lastline );
|
-match => $self->prompt, |
| return;
|
-errmode => "return", |
| }
|
) |
|
|
) |
| $self->logged_in(1);
|
{ |
|
|
$self->last_error( "login ($self->host) failed: " . $self->lastline ); |
| return $self->logged_in;
|
return; |
| }
|
} |
|
|
|
| =pod
|
$self->logged_in(1); |
|
|
|
| =head2 B<parse_login_banner> - Converts the login_banner to something useful.
|
return $self->logged_in; |
|
|
} |
| 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
|
=pod |
| host_type() and firmware_version() as well as login_banner()
|
|
|
|
=head2 B<parse_login_banner> - Converts the login_banner to something useful. |
| =cut
|
|
|
|
Takes a login banner (what you get when you first connect to the Trango) |
| sub parse_login_banner {
|
or reads what is already in login_banner() then parses it and sets |
| my $self = shift;
|
host_type() and firmware_version() as well as login_banner() |
|
|
|
| if (@_) {
|
=cut |
| $self->login_banner(@_);
|
|
| }
|
sub parse_login_banner { |
|
|
my $self = shift; |
| my $banner = $self->login_banner;
|
|
|
|
if (@_) { |
| my ( $type, $sep1, $subtype, $sep2, $ver ) =
|
$self->login_banner(@_); |
| $banner =~
|
} |
| /Welcome to Trango Broadband Wireless (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i;
|
|
|
|
my $banner = $self->login_banner; |
| $type .= $sep1 . $subtype;
|
|
| $ver = $subtype . $sep2 . $ver;
|
my ( $type, $sep1, $subtype, $sep2, $ver ) = |
|
|
$banner =~ |
| $self->login_banner($banner);
|
/Welcome to Trango Broadband Wireless,? (\S+)([\s-]+)(\S+)([\s-]+)(.+)$/i; |
| $self->host_type($type);
|
|
| $self->firmware_version($ver);
|
$type .= $sep1 . $subtype; |
|
|
$ver = $subtype . $sep2 . $ver; |
| return 1;
|
|
| }
|
$self->login_banner($banner); |
|
|
$self->host_type($type); |
| =pod
|
$self->firmware_version($ver); |
|
|
|
| =head2 B<su_password> - Set the password on SUs connected to the AP.
|
return 1; |
|
|
} |
| su_password('new_password'[, 'suid']) If no suid is specified,
|
|
| the default is "all".
|
=pod |
|
|
|
| $t->su_password('good_pass', 5);
|
=head2 B<linktest> - Link test to SU |
|
|
|
| =cut
|
linktest('suid'[, 'pkt len, bytes'[, '# of pkts'[, '# of cycles']]]); |
|
|
|
| sub su_password {
|
Returns a hash reference to the results of the test |
| my $self = shift;
|
|
| my $new_pass = shift || $EMPTY;
|
=cut |
| my $su = shift || 'all';
|
|
|
|
sub linktest |
| unless ( defined $new_pass ) {
|
{ |
| $self->last_error("No new password");
|
my $self = shift; |
|
|
my $suid = shift; |
| #return;
|
# These numbers are what I found as defaults when running the command |
| }
|
my $pkt_len = shift || 1600; |
|
|
my $pkt_cnt = shift || 500; |
| return $self->cmd(
|
my $cycles = shift || 10; |
| String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass,
|
|
| expect => $success,
|
my %config = @_; |
| );
|
|
| }
|
# * 2, one for the FromAP, one FromSU. Then / 1000 to get to ms. |
|
|
# XXX This might need to be changed, this makes the default timeout the |
| =pod
|
# same as $pkt_len, and that might not be enough at slower speeds. |
|
|
$config{Timeout} ||= int(($pkt_len * $pkt_cnt * $cycles * 2 ) / 1000); |
| =head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP.
|
|
|
|
my $string = join $SPACE, 'linktest', $suid, $pkt_len, $pkt_cnt, $cycles; |
| su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' )
|
return $self->cmd( |
|
|
%config, |
| $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' );
|
String => $string, |
|
|
decode => 'linktest', |
| =cut
|
); |
|
|
|
| sub su_ipconfig {
|
} |
| my $self = shift;
|
|
|
|
=pod |
| my $suid = shift;
|
|
| my $new_ip = shift;
|
=head2 B<su_password> - Set the password on SUs connected to the AP. |
| my $new_subnet = shift;
|
|
| my $new_gateway = shift;
|
su_password('new_password'[, 'suid']) If no suid is specified, |
|
|
the default is "all". |
| if ( $suid =~ /\D/ ) {
|
|
| $self->last_error("Invalid suid '$suid'");
|
$t->su_password('good_pass', 5); |
| return;
|
|
| }
|
=cut |
| unless ($new_ip) {
|
|
| $self->last_error("no new_ip passed");
|
sub su_password { |
| return;
|
my $self = shift; |
| }
|
my $new_pass = shift || $EMPTY; |
| unless ($new_subnet) {
|
my $su = shift || 'all'; |
| $self->last_error("no new_subnet passed");
|
|
| return;
|
unless ( defined $new_pass ) { |
| }
|
$self->last_error("No new password"); |
| unless ($new_gateway) {
|
|
| $self->last_error("no new_gateway passed");
|
#return; |
| return;
|
} |
| }
|
|
|
|
return $self->cmd( |
| # su ipconfig <suid> <new ip> <new subnet> <new gateway>
|
String => 'su password ' . $su . $SPACE . $new_pass . $SPACE . $new_pass, |
| return $self->cmd(
|
expect => $success, |
| String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE
|
); |
| . $new_subnet . $SPACE
|
} |
| . $new_gateway,
|
|
| expect => $success,
|
=pod |
| );
|
|
| }
|
=head2 B<su_ipconfig> - Change IP configuration on SUs connected to the AP. |
|
|
|
| =pod
|
su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' ) |
|
|
|
| =head2 B<sudb_view> - Returns the output from the sudb view command
|
$t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' ); |
|
|
|
| returns a reference to an array of hashes each containing these keys
|
=cut |
| 'suid', 'type', 'cir', 'mir' and 'mac'
|
|
|
|
sub su_ipconfig { |
| =cut
|
my $self = shift; |
|
|
|
| sub sudb_view {
|
my $suid = shift; |
| my $self = shift;
|
my $new_ip = shift; |
|
|
my $new_subnet = shift; |
| my $lines = $self->cmd( String => 'sudb view', expect => $success ) || [];
|
my $new_gateway = shift; |
|
|
|
| return unless @{$lines};
|
if ( $suid =~ /\D/ ) { |
|
|
$self->last_error("Invalid suid '$suid'"); |
| unless ( $PRIVATE{'Decode'} ) {
|
return; |
| return $lines;
|
} |
| }
|
unless ($new_ip) { |
|
|
$self->last_error("no new_ip passed"); |
| my @sus;
|
return; |
| foreach ( @{$lines} ) {
|
} |
| next unless $_;
|
unless ($new_subnet) { |
| if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) {
|
$self->last_error("no new_subnet passed"); |
| my %s = (
|
return; |
| suid => $1,
|
} |
| type => $2,
|
unless ($new_gateway) { |
| cir => $3,
|
$self->last_error("no new_gateway passed"); |
| mir => $4,
|
return; |
| mac => $5,
|
} |
| );
|
|
|
|
# su ipconfig <suid> <new ip> <new subnet> <new gateway> |
| $s{'mac'} =~ s/\s//g;
|
return $self->cmd( |
| $s{'mac'} = uc( $s{'mac'} );
|
String => 'su ipconfig ' . $suid . $SPACE . $new_ip . $SPACE |
|
|
. $new_subnet . $SPACE |
| push @sus, \%s;
|
. $new_gateway, |
| }
|
expect => $success, |
| }
|
); |
|
|
} |
| return \@sus;
|
|
| }
|
=pod |
|
|
|
| =pod
|
=head2 B<sudb_view> - Returns the output from the sudb view command |
|
|
|
| =head2 B<sudb_add> - Adds an su to the sudb
|
returns a reference to an array of hashes each containing these keys |
|
|
'suid', 'type', 'cir', 'mir' and 'mac' |
| Takes the following paramaters
|
|
|
|
=cut |
| suid : numeric,
|
|
| type : (reg|pr)
|
sub sudb_view { |
| cir : numeric,
|
my $self = shift; |
| mir : numeric,
|
|
| mac : Almost any format, it will be reformatted,
|
my $lines = $self->cmd( String => 'sudb view', expect => $success ) || []; |
|
|
|
| and returns true on success or undef otherwise.
|
return unless @{$lines}; |
|
|
|
| $t->sudb_add($suid, 'reg', $cir, $mir, $mac);
|
unless ( $PRIVATE{'Decode'} ) { |
|
|
return $lines; |
| You should save_sudb() after calling this, or your changes will be lost
|
} |
| when the AP is rebooted.
|
|
|
|
my @sus; |
| =cut
|
foreach ( @{$lines} ) { |
|
|
next unless $_; |
| sub sudb_add {
|
if (/^\[(\d+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+([0-9A-Fa-f\s]+)$/) { |
| my $self = shift;
|
my %s = ( |
| my $suid = shift;
|
suid => $1, |
| my $type = shift;
|
type => $2, |
| my $cir = shift;
|
cir => $3, |
| my $mir = shift;
|
mir => $4, |
| my $mac = shift;
|
mac => $5, |
|
|
); |
| if ( $suid =~ /\D/ ) {
|
|
| $self->last_error("Invalid suid '$suid'");
|
$s{'mac'} =~ s/\s//g; |
| return;
|
$s{'mac'} = uc( $s{'mac'} ); |
| }
|
|
|
|
push @sus, \%s; |
| unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) {
|
} |
| $self->last_error("Invalid type '$type'");
|
} |
| return;
|
|
| }
|
return \@sus; |
|
|
} |
| if ( $cir =~ /\D/ ) {
|
|
| $self->last_error("Invalid CIR '$cir'");
|
=pod |
| return;
|
|
| }
|
=head2 B<sudb_add> - Adds an su to the sudb |
|
|
|
| if ( $mir =~ /\D/ ) {
|
Takes the following paramaters |
| $self->last_error("Invalid MIR '$mir'");
|
|
| return;
|
suid : numeric, |
| }
|
type : (reg|pr) |
|
|
cir : numeric, |
| my $new_mac = $mac;
|
mir : numeric, |
| $new_mac =~ s/[^0-9A-Fa-f]//;
|
mac : Almost any format, it will be reformatted, |
| unless ( length $new_mac == 12 ) {
|
|
| $self->last_error("Invalid MAC '$mac'");
|
and returns true on success or undef otherwise. |
| return;
|
|
| }
|
$t->sudb_add($suid, 'reg', $cir, $mir, $mac); |
| $new_mac = join $SPACE, $new_mac =~ /../g;
|
|
|
|
You should save_sudb() after calling this, or your changes will be lost |
| my $string =
|
when the AP is rebooted. |
| 'sudb add ' . $suid . $SPACE . $type . $SPACE . $cir . $SPACE . $mir . $SPACE
|
|
| . $new_mac;
|
=cut |
|
|
|
| return $self->cmd( String => $string, expect => $success );
|
sub sudb_add { |
| }
|
my $self = shift; |
|
|
my $suid = shift; |
| =pod
|
my $type = shift; |
|
|
my $cir = shift; |
| =head2 B<sudb_delete> - removes an su from the sudb
|
my $mir = shift; |
|
|
my $mac = shift; |
| Takes either 'all' or the suid of the su to delete
|
|
| and returns true on success or undef otherwise.
|
if ( $suid =~ /\D/ ) { |
|
|
$self->last_error("Invalid suid '$suid'"); |
| $t->sudb_delete($suid);
|
return; |
|
|
} |
| You should save_sudb() after calling this, or your changes will be lost
|
|
| when the AP is rebooted.
|
unless ( lc($type) eq 'reg' || lc($type) eq 'pr' ) { |
|
|
$self->last_error("Invalid type '$type'"); |
| =cut
|
return; |
|
|
} |
| sub sudb_delete {
|
|
| my $self = shift;
|
if ( $cir =~ /\D/ ) { |
| my $suid = shift;
|
$self->last_error("Invalid CIR '$cir'"); |
|
|
return; |
| #if (lc($suid) ne 'all' || $suid =~ /\D/) {
|
} |
| if ( $suid =~ /\D/ ) {
|
|
| $self->last_error("Invalid suid '$suid'");
|
if ( $mir =~ /\D/ ) { |
| return;
|
$self->last_error("Invalid MIR '$mir'"); |
| }
|
return; |
|
|
} |
| return $self->cmd( String => 'sudb delete ' . $suid, expect => $success );
|
|
| }
|
my $new_mac = $mac; |
|
|
$new_mac =~ s/[^0-9A-Fa-f]//g; |
| =pod
|
unless ( length $new_mac == 12 ) { |
|
|
$self->last_error("Invalid MAC '$mac'"); |
| =head2 B<sudb_modify> - changes the su information in the sudb
|
return; |
|
|
} |
| Takes either the suid of the su to change
|
$new_mac = join $SPACE, $new_mac =~ /../g; |
| as well as what you are changing, either "cir, mir or su2su"
|
|
| and returns true on success or undef otherwise.
|
my $string = |
|
|
'sudb add ' . $suid . $SPACE . $type . $SPACE . $cir . $SPACE . $mir . $SPACE |
| cir and mir also take a value to set the cir/mir to.
|
. $new_mac; |
|
|
|
| su2su takes a group id parameter that is in hex.
|
return $self->cmd( String => $string, expect => $success ); |
|
|
} |
| $t->sudb_modify($suid, 'cir', 512);
|
|
|
|
=pod |
| You should save_sudb() after calling this, or your changes will be lost
|
|
| when the AP is rebooted.
|
=head2 B<sudb_delete> - removes an su from the sudb |
|
|
|
| =cut
|
Takes either 'all' or the suid of the su to delete |
|
|
and returns true on success or undef otherwise. |
| sub sudb_modify {
|
|
| my $self = shift;
|
$t->sudb_delete($suid); |
| my $suid = shift;
|
|
| my $opt = shift;
|
You should save_sudb() after calling this, or your changes will be lost |
| my $value = shift;
|
when the AP is rebooted. |
|
|
|
| if ( $suid =~ /\D/ ) {
|
=cut |
| $self->last_error("Invalid suid '$suid'");
|
|
| return;
|
sub sudb_delete { |
| }
|
my $self = shift; |
|
|
my $suid = shift; |
| if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) {
|
|
| if ( $value =~ /\D/ ) {
|
#if (lc($suid) ne 'all' || $suid =~ /\D/) { |
| $self->last_error("Invalid $opt '$value'");
|
if ( $suid =~ /\D/ ) { |
| return;
|
$self->last_error("Invalid suid '$suid'"); |
| }
|
return; |
| }
|
} |
| elsif ( lc($opt) eq 'su2su' ) {
|
|
| if ( $value =~ /[^0-9A-Za-f]/ ) {
|
return $self->cmd( String => 'sudb delete ' . $suid, expect => $success ); |
| $self->last_error("Invalid MAC '$value'");
|
} |
| return;
|
|
| }
|
=pod |
| }
|
|
| else {
|
=head2 B<sudb_modify> - changes the su information in the sudb |
| $self->last_error("Invalid option '$opt'");
|
|
| return;
|
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. |
| my $string = 'sudb modify ' . $suid . $SPACE . $opt . $SPACE . $value;
|
|
|
|
cir and mir also take a value to set the cir/mir to. |
| return $self->cmd( String => $string, expect => $success );
|
|
| }
|
su2su takes a group id parameter that is in hex. |
|
|
|
| =pod
|
$t->sudb_modify($suid, 'cir', 512); |
|
|
|
| =head2 B<enable_tftpd> - enable the TFTP server
|
You should save_sudb() after calling this, or your changes will be lost |
|
|
when the AP is rebooted. |
| runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing
|
|
|
|
=cut |
| =cut
|
|
|
|
sub sudb_modify { |
| sub enable_tftpd {
|
my $self = shift; |
| my $self = shift;
|
my $suid = shift; |
|
|
my $opt = shift; |
| my $vals = $self->tftpd( args => 'on' );
|
my $value = shift; |
|
|
|
| if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) {
|
if ( $suid =~ /\D/ ) { |
| return $vals;
|
$self->last_error("Invalid suid '$suid'"); |
| }
|
return; |
| else {
|
} |
| return;
|
|
| }
|
if ( lc($opt) eq 'cir' or lc($opt) eq 'mir' ) { |
| }
|
if ( $value =~ /\D/ ) { |
|
|
$self->last_error("Invalid $opt '$value'"); |
| =pod
|
return; |
|
|
} |
| =head2 B<disable_tftpd> - disable the TFTP server
|
} |
|
|
elsif ( lc($opt) eq 'su2su' ) { |
| runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled'
|
if ( $value =~ /[^0-9A-Za-f]/ ) { |
|
|
$self->last_error("Invalid MAC '$value'"); |
| =cut
|
return; |
|
|
} |
| sub disable_tftpd {
|
} |
| my $self = shift;
|
else { |
|
|
$self->last_error("Invalid option '$opt'"); |
| my $vals = $self->tftpd( args => 'off' );
|
return; |
|
|
} |
| if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled' ) {
|
|
| return $vals;
|
my $string = 'sudb modify ' . $suid . $SPACE . $opt . $SPACE . $value; |
| }
|
|
| else {
|
return $self->cmd( String => $string, expect => $success ); |
| return;
|
} |
| }
|
|
| }
|
=pod |
|
|
|
| =pod
|
=head2 B<enable_tftpd> - enable the TFTP server |
|
|
|
| =head2 B<cmd> - runs a command on the AP.
|
runs C<tftpd(args =E<gt> 'on')> and makes sure that Tftpd is now 'listen'ing |
|
|
|
| This does most of the work. At the heart, it calls Net::Telnet::cmd()
|
=cut |
| but it also does some special stuff for Trango.
|
|
|
|
sub enable_tftpd { |
| Normally returns the last lines from from the command
|
my $self = shift; |
|
|
|
| If you are using this, rather than one of the "easy" methods above,
|
my $vals = $self->tftpd( args => 'on' ); |
| you probably want to read through the source of this module to see how
|
|
| some of the other commands are called.
|
if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'listen' ) { |
|
|
return $vals; |
| In addition to the Net::Telnet::cmd() options, it also accepts these:
|
} |
|
|
else { |
| I<decode>
|
return; |
| - if this is true, then it will send the output lines to _decode_lines()
|
} |
| and then returns the decoded output
|
} |
|
|
|
| I<no_prompt>
|
=pod |
| - if this is true, it does not wait for a prompt, so you are not stuck
|
|
| waiting for something that will never happen.
|
=head2 B<disable_tftpd> - disable the TFTP server |
|
|
|
| I<cmd_disconnects>
|
runs C<tftpd(args =E<gt> 'off')> and makes sure that Tftpd is now 'disabled' |
| - if this is true, it then sets logged_in() to false, then it will
|
|
| close() the connection and set is_connected() to false
|
=cut |
|
|
|
| I<expect>
|
sub disable_tftpd { |
| - if this is set (usually to 'Success.') it will check for that in the
|
my $self = shift; |
| last line of output and if it does not, will return undef because the
|
|
| command probably failed
|
my $vals = $self->tftpd( args => 'off' ); |
|
|
|
| I<args>
|
if ( ref $vals eq 'HASH' && $vals->{'Tftpd'} eq 'disabled' ) { |
| - a string containing the command line options that are passed to the
|
return $vals; |
| command
|
} |
|
|
else { |
| $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 );
|
return; |
|
|
} |
| =cut
|
} |
|
|
|
| sub cmd {
|
=pod |
| my $self = shift;
|
|
|
|
=head2 B<cmd> - runs a command on the AP. |
| my @valid_net_telnet_opts = qw(
|
|
| String
|
This does most of the work. At the heart, it calls Net::Telnet::cmd() |
| Output
|
but it also does some special stuff for Trango. |
| Cmd_remove_mode
|
|
| Errmode
|
Normally returns the last lines from from the command |
| Input_record_separator
|
|
| Ors
|
If you are using this, rather than one of the "easy" methods above, |
| Output_record_separator
|
you probably want to read through the source of this module to see how |
| Prompt
|
some of the other commands are called. |
| Rs
|
|
| Timeout
|
In addition to the Net::Telnet::cmd() options, it also accepts these: |
| );
|
|
|
|
I<decode> |
| my %cfg;
|
- if this is true, then it will send the output lines to _decode_lines() |
| if ( @_ == 1 ) {
|
and then returns the decoded output |
| $cfg{'String'} = shift;
|
|
| }
|
I<no_prompt> |
| elsif ( @_ > 1 ) {
|
- if this is true, it does not wait for a prompt, so you are not stuck |
| %cfg = @_;
|
waiting for something that will never happen. |
| }
|
|
|
|
I<cmd_disconnects> |
| $cfg{'Timeout'} ||= $self->Timeout;
|
- if this is true, it then sets logged_in() to false, then it will |
|
|
close() the connection and set is_connected() to false |
| unless ( $cfg{'String'} ) {
|
|
| $self->last_error("No command passed");
|
I<expect> |
| return;
|
- 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 |
| unless ( $self->is_connected ) {
|
|
| $self->last_error("Not connected");
|
I<args> |
| return;
|
- a string containing the command line options that are passed to the |
| }
|
command |
|
|
|
| unless ( $self->logged_in ) {
|
$t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); |
| $self->last_error("Not logged in");
|
|
| return;
|
=cut |
| }
|
|
|
|
sub cmd { |
| my %cmd;
|
my $self = shift; |
| foreach (@valid_net_telnet_opts) {
|
|
| if ( exists $cfg{$_} ) {
|
my @valid_net_telnet_opts = qw( |
| $cmd{$_} = $cfg{$_};
|
String |
| }
|
Output |
| }
|
Cmd_remove_mode |
| if ( $cfg{'args'} ) {
|
Errmode |
| $cmd{'String'} .= $SPACE . $cfg{'args'};
|
Input_record_separator |
| }
|
Ors |
|
|
Output_record_separator |
| my @lines;
|
Prompt |
| if ( $cfg{'no_prompt'} ) {
|
Rs |
| $self->print( $cmd{'String'} );
|
Timeout |
| @lines = $self->lastline;
|
); |
| }
|
|
| else {
|
my %cfg; |
| @lines = $self->SUPER::cmd(%cmd);
|
if ( @_ == 1 ) { |
| }
|
$cfg{'String'} = shift; |
|
|
} |
| $self->last_lines( \@lines );
|
elsif ( @_ > 1 ) { |
|
|
%cfg = @_; |
| my $vals = 1;
|
} |
| if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
|
|
| if ( $cfg{'decode'} eq 'each' ) {
|
$cfg{'Timeout'} ||= $self->Timeout; |
| $vals = _decode_each_line(@lines);
|
|
| }
|
unless ( $cfg{'String'} ) { |
| elsif ( $cfg{'decode'} eq 'sulog' ) {
|
$self->last_error("No command passed"); |
| $vals = _decode_sulog(@lines);
|
return; |
| }
|
} |
| elsif ( $cfg{'decode'} eq 'maclist' ) {
|
|
| $vals = _decode_maclist(@lines);
|
unless ( $self->is_connected ) { |
| }
|
$self->last_error("Not connected"); |
| else {
|
return; |
| $vals = _decode_lines(@lines);
|
} |
| }
|
|
| }
|
unless ( $self->logged_in ) { |
|
|
$self->last_error("Not logged in"); |
| $self->last_vals($vals);
|
return; |
|
|
} |
| my $last = $self->lastline;
|
|
|
|
my %cmd; |
| if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) {
|
foreach (@valid_net_telnet_opts) { |
| if ( $cfg{'cmd_disconnects'} ) {
|
if ( exists $cfg{$_} ) { |
| $self->logged_in(0);
|
$cmd{$_} = $cfg{$_}; |
| $self->close;
|
} |
| $self->is_connected(0);
|
} |
| }
|
if ( $cfg{'args'} ) { |
|
|
$cmd{'String'} .= $SPACE . $cfg{'args'}; |
| if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) {
|
} |
| return $vals;
|
|
| }
|
#print "Running cmd $cmd{String}\n"; |
| else {
|
my @lines; |
| return \@lines;
|
if ( $cfg{'no_prompt'} ) { |
| }
|
$self->print( $cmd{'String'} ); |
| }
|
@lines = $self->lastline; |
| else {
|
} |
| my $err;
|
else { |
| if (grep { /\[ERR\]/ } @lines) {
|
@lines = $self->SUPER::cmd(%cmd); |
| $err = _decode_lines(@lines);
|
} |
| }
|
|
|
|
$self->last_lines( \@lines ); |
| if (ref $err eq 'HASH' && $err ->{ERR}) {
|
|
| $self->last_error($err->{ERR} );
|
my $last = $self->lastline; |
| } else {
|
my $prompt = $self->prompt; |
| $self->last_error("Error with command ($cfg{'String'}): $last");
|
$prompt =~ s{^/}{}xms; |
| }
|
$prompt =~ s{/[gixms]*$}{}xms; |
| return;
|
while (@lines && $last =~ qr($prompt)) { |
| }
|
pop @lines; |
| }
|
$last = $lines[-1]; |
|
|
} |
| #=item _decode_lines
|
$self->last_error($EMPTY); |
|
|
|
| sub _decode_lines {
|
my $vals = 1; |
| my @lines = @_;
|
if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) { |
|
|
if ( $cfg{'decode'} eq 'each' ) { |
| my %conf;
|
$vals = _decode_each_line(@lines); |
|
|
} |
| my $key = $EMPTY;
|
elsif ( $cfg{'decode'} eq 'sulog' ) { |
| my $val = undef;
|
$vals = _decode_sulog(@lines); |
| my @vals;
|
} |
| my $in_key = 0;
|
elsif ( $cfg{'decode'} eq 'maclist' ) { |
| my $in_val = 1;
|
$vals = _decode_maclist(@lines); |
|
|
if (! $vals) { |
| foreach my $line (@lines) {
|
$self->last_error("Error decoding maclist"); |
| next if $line =~ /$success$/;
|
} |
|
|
} |
| my @chars = split //, $line;
|
elsif ( $cfg{'decode'} eq 'linktest' ) { |
|
|
$vals = _decode_linktest(@lines); |
| my $last_key = $EMPTY;
|
if (! $vals) { |
| foreach my $c (@chars) {
|
$self->last_error("Error decoding linktest"); |
|
|
} |
| if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) {
|
} |
| if ( $c eq '[' ) {
|
else { |
| $in_key = 1;
|
$vals = _decode_lines(@lines); |
| $in_val = 0;
|
} |
| }
|
} |
| else {
|
$self->last_vals($vals); |
| $in_key = 0;
|
|
| $in_val = 1;
|
if ( ( not $cfg{'expect'} ) || $last =~ /$cfg{'expect'}$/ ) { |
| }
|
if ( $cfg{'cmd_disconnects'} ) { |
|
|
$self->logged_in(0); |
| if ($key) {
|
$self->close; |
| $key =~ s/^\s+//;
|
$self->is_connected(0); |
| $key =~ s/\s+$//;
|
} |
|
|
|
| if ($val) {
|
if ( $PRIVATE{'Decode'} && $cfg{'decode'} ) { |
| $val =~ s/^\s+//;
|
return $vals; |
| $val =~ s/\s+$//;
|
} |
| }
|
else { |
|
|
return \@lines; |
| if ( $key eq 'Checksum' && $last_key ) {
|
} |
|
|
} |
| # Special case for these bastids.
|
else { |
| my $new = $last_key;
|
my $err; |
| $new =~ s/\s+\S+$//;
|
if (grep { /\[ERR\]/ } @lines) { |
| $key = $new . $SPACE . $key;
|
$err = _decode_lines(@lines); |
| }
|
} |
|
|
|
| $conf{$key} = $val;
|
if (ref $err eq 'HASH' && $err->{ERR}) { |
| $last_key = $key;
|
$self->last_error($err->{ERR} ); |
| $key = $EMPTY;
|
} else { |
| }
|
$self->last_error("Error with command ($cmd{'String'}): $last"); |
| elsif ($val) {
|
} |
| push @vals, $val;
|
return; |
| }
|
} |
| $val = $EMPTY;
|
} |
|
|
|
| }
|
#=item _decode_lines |
| elsif ( $c eq ']' ) {
|
|
| $in_val = 1;
|
sub _decode_lines { |
| $in_key = 0;
|
my @lines = @_; |
| $c = shift @chars;
|
|
|
|
my %conf; |
| }
|
|
| elsif ($in_key) {
|
my $key = $EMPTY; |
| $key .= $c;
|
my $val = undef; |
|
|
my @vals; |
| }
|
my $in_key = 0; |
| elsif ($in_val) {
|
my $in_val = 1; |
| $val .= $c;
|
|
| }
|
LINE: while (my $line = shift @lines) { |
| }
|
next LINE if $line =~ /$success\Z/; |
| }
|
next LINE if $line =~ /^ \*+ \s+ \d+ \s+ \*+ \Z/xms; |
|
|
|
| unless ($key) {
|
# Special decode for sysinfo on a TrangoLink 45 |
| push @vals, $val;
|
if ($line =~ /^(.* Channel \s+ Table):\s*(.*)\Z/xms) { |
| }
|
my $key = $1; |
|
|
my $note = $2; |
| if ( @vals == 1 ) {
|
|
| $val = $vals[0];
|
my %vals; |
| }
|
while ($line = shift @lines) { |
| elsif (@vals) {
|
if ($line =~ /^\Z/) { |
| $val = \@vals;
|
$conf{$key} = \%vals; |
| }
|
$conf{$key}{note} = $note; |
| else {
|
next LINE; |
| $val = undef;
|
} |
| }
|
|
|
|
my $decoded = _decode_lines($line); |
| if (%conf) {
|
if ($decoded) { |
| $conf{_pre} = $val if $val;
|
%vals = (%vals, %{ $decoded }); |
| return \%conf;
|
} |
| }
|
} |
| else {
|
} |
| return $val;
|
# Another special decode for the TrangoLink |
| }
|
elsif ($line =~ /^ |
| }
|
RF \s Band \s \# |
|
|
(\d+) \s+ |
| #=item _decode_each_line
|
\( ([^\)]+) \) \s* |
|
|
(.*)$ |
| sub _decode_each_line {
|
/xms) { |
| my @lines = @_;
|
my $num = $1; |
| my @decoded;
|
my $band = $2; |
| foreach my $line (@lines) {
|
my $extra = $3; |
| my $decoded = _decode_lines($line);
|
|
| push @decoded, $decoded if defined $decoded;
|
if ($extra =~ /\[/) { |
| }
|
my $decoded = _decode_lines($extra); |
| return \@decoded;
|
$conf{'RF Band'}{$num} = $decoded; |
| }
|
} |
|
|
else { |
| #=item _decode_sulog
|
$conf{'RF Band'}{$num}{$extra} = 1; |
|
|
} |
| sub _decode_sulog {
|
next LINE; |
| my @lines = @_;
|
} |
| my @decoded;
|
|
| my $last_tm;
|
my @chars = split //, $line; |
| foreach my $line (@lines) {
|
|
| my $decoded = _decode_lines($line);
|
my $last_key = $EMPTY; |
|
|
foreach my $c (@chars) { |
| if ( defined $decoded ) {
|
|
| if ( $decoded->{'tm'} ) {
|
if ( $c eq '[' || $c eq "\r" || $c eq "\n" ) { |
| $last_tm = $decoded->{'tm'};
|
if ( $c eq '[' ) { |
| next;
|
$in_key = 1; |
| }
|
$in_val = 0; |
| else {
|
} |
| $decoded->{'tm'} = $last_tm;
|
else { |
| }
|
$in_key = 0; |
| next unless $last_tm;
|
$in_val = 1; |
|
|
} |
| push @decoded, $decoded if defined $decoded;
|
|
| }
|
if ($key) { |
| }
|
$key =~ s/^\s+//; |
| return \@decoded;
|
$key =~ s/\s+$//; |
| }
|
|
|
|
if ($val) { |
| #=item _decode_maclist
|
$val =~ s/^\s+//; |
|
|
$val =~ s/\s+$//; |
| sub _decode_maclist {
|
} |
| my @lines = @_;
|
|
| my @decoded;
|
if ( $key eq 'Checksum' && $last_key ) { |
| my $total_entries = 0;
|
|
| my $current_tm = 0;
|
# Special case for these bastids. |
| foreach my $line (@lines) {
|
my $new = $last_key; |
| $line =~ s/\r?\n$//;
|
$new =~ s/\s+\S+$//; |
| my ( $mac, $loc, $tm ) = $line =~ /
|
$key = $new . $SPACE . $key; |
| ([0-9a-fA-F ]{17})\s+
|
} |
| (.*)\s+
|
|
| tm\s+
|
$conf{$key} = $val; |
| (\d+)
|
$last_key = $key; |
| /x;
|
$key = $EMPTY; |
|
|
} |
| if ($mac) {
|
elsif ($val) { |
| $mac =~ s/\s+//g;
|
push @vals, $val; |
| $loc =~ s/^\s+//;
|
} |
| $loc =~ s/\s+$//;
|
$val = $EMPTY; |
|
|
|
| my $suid = undef;
|
} |
| if ( $loc =~ /suid\s+=\s+(\d+)/ ) {
|
elsif ( $c eq ']' ) { |
| $suid = $1;
|
$in_val = 1; |
| $loc = undef;
|
$in_key = 0; |
| }
|
$c = shift @chars; |
|
|
|
| push @decoded,
|
} |
| {
|
elsif ($in_key) { |
| mac => $mac,
|
$key .= $c; |
| loc => $loc,
|
|
| tm => $tm,
|
} |
| suid => $suid,
|
elsif ($in_val) { |
| };
|
$val .= $c; |
| }
|
} |
| elsif ( $line =~ /(\d+)\s+entries/ ) {
|
} |
| $total_entries = $1;
|
} |
| }
|
|
| elsif ( $line =~ /current tm = (\d+)\s+sec/ ) {
|
unless ($key) { |
| $current_tm = $1;
|
push @vals, $val; |
| }
|
} |
| }
|
|
|
|
if ( @vals == 1 ) { |
| map { $_->{'cur_tm'} = $current_tm } @decoded;
|
$val = $vals[0]; |
|
|
} |
| if ( scalar @decoded == $total_entries ) {
|
elsif (@vals) { |
| return \@decoded;
|
$val = \@vals; |
| }
|
} |
| else {
|
else { |
|
|
$val = undef; |
| # XXX we should have a way to set last error, not sure why we don't
|
} |
| return;
|
|
| }
|
if (%conf) { |
| }
|
$conf{_pre} = $val if $val; |
|
|
return \%conf; |
| 1; # End of Net::Telnet::Trango
|
} |
| __END__
|
else { |
|
|
return $val; |
| =head1 SEE ALSO
|
} |
|
|
} |
| Trango Documentation -
|
|
| L<http://www.trangobroadband.com/support/product_docs.htm>
|
#=item _decode_each_line |
|
|
|
| L<Net::Telnet>
|
sub _decode_each_line { |
|
|
my @lines = @_; |
| =head1 TODO
|
my @decoded; |
|
|
foreach my $line (@lines) { |
| There are still a lot of commands that are not accessed directly. If
|
my $decoded = _decode_lines($line); |
| you call them (as cmd("command + args") or whatever) and it works,
|
push @decoded, $decoded if defined $decoded; |
| please send me examples that work and I will try to get it incorporated
|
} |
| into the next version of the script.
|
return \@decoded; |
|
|
} |
| 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
|
#=item _decode_linktest |
| available as a perl datastructure.
|
|
|
|
sub _decode_linktest { |
| =head1 AUTHOR
|
my @lines = @_; |
|
|
my %decoded; |
| Andrew Fresh E<lt>andrew@rraz.netE<gt>
|
foreach my $line (@lines) { |
|
|
|
| =head1 SUPPORT
|
if ($line =~ s/^(\d+) \s+ //xms) { |
|
|
my $line_id = $1; |
| You can find documentation for this module with the perldoc command.
|
my ($tm, $rt); |
|
|
if ($line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms) { |
| perldoc Net::Telnet::Trango
|
$rt = $1; |
|
|
} |
| You can also look for information at:
|
if ($line =~ s/\s+ (\d+ \s+ \w+) \s* $//xms) { |
|
|
$tm = $1; |
| =over 4
|
} |
|
|
|
| =item * AnnoCPAN: Annotated CPAN documentation
|
my $d = _decode_lines($line. "\n"); |
|
|
$decoded{tests}[$line_id] = $d; |
| L<http://annocpan.org/dist/Net-Telnet-Trango>
|
$decoded{tests}[$line_id]{'time'} = $tm; |
|
|
$decoded{tests}[$line_id]{rate} = $rt; |
| =item * CPAN Ratings
|
} |
|
|
|
| L<http://cpanratings.perl.org/d/Net-Telnet-Trango>
|
else { |
|
|
my $d = _decode_lines($line . "\n"); |
| =item * RT: CPAN's request tracker
|
if ($d) { |
|
|
while (my ($k, $v) = each %{ $d }) { |
| L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Telnet-Trango>
|
$decoded{$k} = $v; |
|
|
} |
| =item * Search CPAN
|
} |
|
|
} |
| L<http://search.cpan.org/dist/Net-Telnet-Trango>
|
|
|
|
} |
| =back
|
return \%decoded; |
|
|
} |
| =head1 COPYRIGHT AND LICENSE
|
|
|
|
#=item _decode_sulog |
| Copyright (C) 2005,2006,2007 by Andrew Fresh
|
|
|
|
sub _decode_sulog { |
| This program is free software; you can redistribute it and/or modify it
|
my @lines = @_; |
| under the same terms as Perl itself.
|
my @decoded; |
|
|
my $last_tm; |
| =cut
|
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 { |
| |
return; |
| |
} |
| |
} |
| |
|
| |
1; # End of Net::Telnet::Trango |
| |
__END__ |
| |
|
| |
=head1 SEE ALSO |
| |
|
| |
Trango Documentation - |
| |
L<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 SUPPORT |
| |
|
| |
You can find documentation for this module with the perldoc command. |
| |
|
| |
perldoc Net::Telnet::Trango |
| |
|
| |
You can also look for information at: |
| |
|
| |
=over 4 |
| |
|
| |
=item * AnnoCPAN: Annotated CPAN documentation |
| |
|
| |
L<http://annocpan.org/dist/Net-Telnet-Trango> |
| |
|
| |
=item * CPAN Ratings |
| |
|
| |
L<http://cpanratings.perl.org/d/Net-Telnet-Trango> |
| |
|
| |
=item * RT: CPAN's request tracker |
| |
|
| |
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-Telnet-Trango> |
| |
|
| |
=item * Search CPAN |
| |
|
| |
L<http://search.cpan.org/dist/Net-Telnet-Trango> |
| |
|
| |
=back |
| |
|
| |
=head1 COPYRIGHT AND LICENSE |
| |
|
| |
Copyright (C) 2005,2006,2007 by Andrew Fresh |
| |
|
| |
This program is free software; you can redistribute it and/or modify it |
| |
under the same terms as Perl itself. |
| |
|
| |
=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