NAME

Device::Router::RTX - interact with Yamaha RTX routers

SYNOPSIS

METHODS

new

my $rtx = Device::Router::RTX->new (
    address => '12.34.56.78',
    password => 'password',
    admin_password => 'administrator password',
);

Create a new object for communicating with the router. The IP address of the router is compulsory. If the router has a password set, you also need to supply a password.

This does not open a telnet connection to the router. Use "connect" to open the telnet connection.

connect

$rtx->connect ();

Connect to the router. This dies if there is an error.

get_config

$rtx->get_config ("config");

Get the router's configuration file and put it into the file config.

read_config

$rtx->read_config ("config");

Read a router configuration file from the file specified. (This method is not fully functional yet.)

save

$rtx->save ();

Save an altered configuration to the router's permanent memory.

command

$rtx->command ($command);

Send a command to the router specified by $command, and save it.

wake

$rtx->wake (<LAN>,<MAC>);

Send a "wake-on-lan" ("wol") packet to the specified MAC address on the specified LAN (give the number of the LAN, e.g. 1-3 for RTX1000 routers). There is no return value.

arp

my $arp = $rtx->arp();
if ($arp) {
    for my $entry (@$arp) {
        print "MAC: $entry->{mac} IP: $entry->{ip}.\n";
    } 
} 

Read the router's arp table. The return value is the undefined value if the command fails, or an array reference containing hash references if it succeeds. The hash references have four fields, lan (the number of the local area network), ip (the IP address), mac (the MAC address) and ttl (time to live).

SEE ALSO

About RTX routers

http://jp.yamaha.com/products/network/routers/

Yamaha's router site.

http://www.lemoda.net/networking/rtx1000/

A guide to some of the router's commands.

Other Perl modules

Net::MAC::Vendor - look up the vendor for a MAC.

DISCLAIMER

The author of this Perl module is not and has never been affiliated with Yamaha Corporation. The author cannot take any responsibility for what happens to your router if you use this module. Use at your own risk.

AUTHOR

Ben Bullock, <bkb@cpan.org>

COPYRIGHT & LICENCE

This package and associated files are copyright (C) 2012 Ben Bullock.

You can use, copy, modify and redistribute this package and associated files under the Perl Artistic Licence or the GNU General Public Licence.