=================================================================== RCS file: /cvs/trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm,v retrieving revision 1.25 retrieving revision 1.26 diff -u -r1.25 -r1.26 --- trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/01/17 20:48:46 1.25 +++ trango/Net-Telnet-Trango/lib/Net/Telnet/Trango.pm 2007/01/17 23:15:13 1.26 @@ -1,5 +1,5 @@ package Net::Telnet::Trango; -# $RedRiver: Trango.pm,v 1.24 2007/01/17 19:00:51 andrew Exp $ +# $RedRiver: Trango.pm,v 1.25 2007/01/17 20:48:46 andrew Exp $ use strict; use warnings; use base 'Net::Telnet'; @@ -8,7 +8,8 @@ =head1 NAME -Net::Telnet::Trango - Perl extension for accessing the Trango telnet interface +Net::Telnet::Trango +- Perl extension for accessing the Trango telnet interface =head1 SYNOPSIS @@ -52,10 +53,16 @@ =pod -=item new +=item B -Same as new from L but has defaults for the trango 'Prompt' +- Creates a new Net::Telnet::Trango object. + new([Options from Net::Telnet,] + [Decode => 0,]); + +Same as new from L but sets the default Trango Prompt: +'/#> *$/' + It also takes an optional parameter 'Decode'. If not defined it defaults to 1, if it is set to 0, it will not decode the output and instead return an array of the lines that were returned from the @@ -168,65 +175,76 @@ =head2 ACCESSORS +These are usually only set internally. + =over -=item Host +=item B -returns the name of the host that you are accessing +- returns the name of the host that you are accessing -=item firmware_version +=item B -returns the firmware version on the trango if available otherwise undef. -Available after a successful open() -This is usually only set internally +- returns the firmware version -=item host_type +Returns the firmware version if available, otherwise undef. +It should be available after a successful open(). + +=item B + +- return the type of host you are connected to. + returns the type of host from the login banner for example M5830S or M5300S. -Available after a successful open() -This is usually only set internally -=item is_connected +Should be available after a successful open(). -returns 1 after a successful open() otherwise undef -This is usually only set internally +=item B -=item logged_in +- Status of the connection to host. -returns 1 after a successful login() 0 if it failed and undef if -login() was never called -This is usually only set internally +returns 1 when connected, undef otherwise. -=item login_banner +=item B +- Status of being logged in to the host. + +returns 1 after a successful login(), 0 if it failed and undef if +login() was never called. + +=item B + +- The banner when first connecting to the host. + returns the banner that is displayed when first connected at login. -Only set after a successful open() +Only set after a successful open(). -This is usually only set internally +=item B -=item last_lines +- The last lines of output from the last cmd(). -returns the output from the last cmd() that was run as an array ref -This is usually only set internally +returns, as an array ref, the output from the last cmd() that was run. -=item last_error +=item B -returns the last error reported. Should contain the the last entry in -last_lines +- A text output of the last error that was encountered. +returns the last error reported. Probably contains the last entry in +last_lines. + =back =head2 ALIASES =over -=item bye +=item B -alias of exit() +- alias of L. -=item restart +=item B -alias of reboot() +- alias of L. =back @@ -239,69 +257,88 @@ =over -=item tftpd +=item B -Returns a hash ref of the decoded output from the command. +- Returns a hash ref of the decoded output from the +command. -Also see enable_tftpd() and disable_tftpd() as those check for correct output +Also see enable_tftpd() and disable_tftpd() as those check that it was +successfully changed. -=item ver +=item B -Returns a hash ref of the decoded output from the command. +- Returns a hash ref of the decoded output from the +command. -=item sysinfo +=item B -Returns a hash ref of the decoded output from the command. +- Returns a hash ref of the decoded output from the +command. -=item exit +=item B -exits the command session with the trango and closes the connection +- exits the command session with the Trango and closes +the connection -=item reboot +=item B -reboots the trango and closes the connection +- reboots the Trango and closes the connection -=item remarks +=item B +- Set or retrieve the remarks. + Takes an optional argument, which sets the remarks. If there is no argument, returns the current remarks. -=item sulog + my $old_remarks = $t->remarks(); + $t->remarks($new_remarks); -returns an array ref of hashes containing each log line. +=item B -=item save_sudb +- returns an array ref of hashes containing each log +line. -returns true on success, undef on failure +=item B -=item syslog +- returns true on success, undef on failure -returns the output from the syslog command +=item B -=item pipe +- returns the output from the syslog command -returns the output from the pipe command +=item B -=item maclist +- returns the output from the pipe command -returns the output from the maclist command +=item B -=item maclist_reset +- returns the output from the maclist command -resets the maclist. No useful output. +=item B -=item eth_list +- resets the maclist. -returns the output from the eth list command +No useful output. -=item su_info +=item B -You need to pass in args => and it will return the info for that suid. +- returns the output from the eth list command -=item save_ss +=item B -saves the config. Returns 1 on success, undef on failure. +- returns information about the SU. +You need to pass in the $suid and it will return the info for that suid. + + $t->su_info($suid); + +=item B + +- saves the config. + +Returns 1 on success, undef on failure. + =cut @@ -379,8 +416,10 @@ =pod -=item open +=item B +- Open a connection to a Trango AP. + Calls Net::Telnet::open() then makes sure you get a password prompt so you are ready to login() and parses the login banner so you can get host_type() and firmware_version() @@ -415,8 +454,10 @@ =pod -=item login +=item B +- Login to the AP. + Calls open() if not already connected, then sends the password and sets logged_in() if successful @@ -448,8 +489,11 @@ =pod -=item parse_login_banner +=item B +- Converts the login_banner to some useful +variables. + Takes a login banner (what you get when you first connect to the Trango) or reads what is already in login_banner() then parses it and sets host_type() and firmware_version() as well as login_banner() @@ -478,11 +522,15 @@ =pod -=item su_password +=item B -C If no suid is specified, +- Set the password on SUs connected to the AP. + +su_password('new_password'[, 'suid']) If no suid is specified, the default is "all". + $t->su_password('good_pass', 5); + =cut sub su_password @@ -506,10 +554,15 @@ =pod -=item su_ipconfig +=item B -C +- Change IP configuration on SUs connected to +the AP. +su_ipconfig( 'suid', 'new_ip', 'new_subnet', 'new_gateway' ) + + $t->su_ipconfig( 5, '10.0.1.5', '255.255.255.0', '10.0.1.1' ); + =cut sub su_ipconfig @@ -550,15 +603,12 @@ =pod -=item sudb_view +=item B -returns a reference to an array of hashes each containing: +- Returns the output from the sudb view command - suid - type - cir - mir - mac +returns a reference to an array of hashes each containing these keys +'suid', 'type', 'cir', 'mir' and 'mac' =cut @@ -598,7 +648,7 @@ =pod -=item sudb_add +=item B Takes the following paramaters @@ -610,6 +660,8 @@ and returns true on success or undef otherwise. + $t->sudb_add($suid, 'reg', $cir, $mir, $mac); + You should save_sudb() after calling this, or your changes will be lost when the AP is rebooted. @@ -665,11 +717,13 @@ =pod -=item sudb_delete +=item B Takes either 'all' or the suid of the su to delete and returns true on success or undef otherwise. + $t->sudb_delete($suid); + You should save_sudb() after calling this, or your changes will be lost when the AP is rebooted. @@ -691,9 +745,9 @@ =pod -=item sudb_modify +=item B -Takes either the suid of the su to delete +Takes either the suid of the su to change as well as what you are changing, either "cir, mir or su2su" and returns true on success or undef otherwise. @@ -701,6 +755,8 @@ su2su takes a group id parameter that is in hex. + $t->sudb_modify($suid, 'cir', 512); + You should save_sudb() after calling this, or your changes will be lost when the AP is rebooted. @@ -740,8 +796,10 @@ =pod -=item enable_tftpd +=item B +- enable the TFTP server + runs C 'on')> and makes sure that Tftpd is now 'listen'ing =cut @@ -761,8 +819,10 @@ =pod -=item disable_tftpd +=item B +- disable the TFTP server + runs C 'off')> and makes sure that Tftpd is now 'disabled' =cut @@ -782,32 +842,49 @@ =pod -=item cmd +=item B +- runs a command on the AP. + This does most of the work. At the heart, it calls Net::Telnet::cmd() but it also does some special stuff for Trango. Normally returns the last lines from from the command -Also accepts these options: +If you are using this, rather than one of the "easy" methods above, +you probably want to read through the source of this module to see how +some of the other commands are called. +In addition to the Net::Telnet::cmd() options, it also accepts these: + I + - if this is true, then it will send the output lines to _decode_lines() and then returns the decoded output +I + +- if this is true, it does not wait for a prompt, so you are not stuck +waiting for something that will never happen. + I + - if this is true, it then sets logged_in() to false, then it will -close() the connection and then sets is_connected() to false +close() the connection and set is_connected() to false I + - if this is set (usually to 'Success.') it will check for that in the last line of output and if it does not, will return undef because the command probably failed I + - a string containing the command line options that are passed to the command + $t->cmd( String => 'exit', no_prompt => 1, cmd_disconnects => 1 ); + =cut sub cmd @@ -1076,8 +1153,7 @@ =head1 SEE ALSO -Trango Documentation - -http://www.trangobroadband.com/support/product_docs.htm +Trango Documentation - http://www.trangobroadband.com/support/product_docs.htm L @@ -1098,11 +1174,10 @@ =head1 COPYRIGHT AND LICENSE -Copyright (C) 2005 by Andrew Fresh +Copyright (C) 2005,2006,2007 by Andrew Fresh This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available. - =cut