/ 
Net-SNMP-Poller-0.01
River stage zero No dependents
/ Net::SNMP::Poller

NAME

Net::SNMP::Poller - Simple poller for non-blocking SNMP queries

VERSION

Version 0.01

SYNOPSIS

This module takes a hashref of hosts -> session / request info, performs SNMP queries then returns the results.

use Net::SNMP::Poller;

# so far, logfile is the only supported option
my $opts = {
    logfile => '/tmp/log',
};

my $obj = Net::SNMP::Poller->new( $opts ); # $opts is optional

# data structure is hostname => key-value pairs of SNMP session / request
# information.  You can specify any options that Net::SNMP::session() and
# Net::SNMP::get_request() methods are supporting.  This module will perform
# overrides appropriately.
my $ref = {
    'localhost' => {
        version     => 1,
        community   => 'public',
        varbindlist => [ '.1.3.6.1.4.1.2021.11.50.0' ],
    },
};

my $data = $obj->run( $ref );

# the content of $data would be the following:
$data = {
      'localhost' => {
                       '.1.3.6.1.4.1.2021.11.50.0' => 414695
                     }
};

SUBROUTINES/METHODS

new

Description: The constructor
Arguments: Optional hashref for options
Returns: Object

init

Description: Validates args and initializes the object
Arguments: none
Returns: none, but can croak on errors

run

Description: Performs non-blocking snmp queries and return a data structure
Arguments: hashref of hostname => key-value pairs of session / request info
Returns: data structure host -> OID -> value.

callback

Description: Callback method for Net::SNMP to invoke.
Arguments: Net::SNMP object (implicitly passed in via the module)
Returns: None, but populates $self->{ data } for run() to return

AUTHOR

Satoshi Yagi, <satoshi.yagi at yahoo.com>

BUGS

Please report any bugs or feature requests to bug-net-snmp-poller at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-SNMP-Poller. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Net::SNMP::Poller

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2012 Satoshi Yagi.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.