Roy Elton Crowder, III > Nagios-Status-ServiceStatus-0.01 > Nagios::Status::ServiceStatus

Download:
Nagios-Status-ServiceStatus-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Nagios::Status::ServiceStatus - Nagios 3.0 Class to maintain Services' Status.

VERSION ^

Version 0.01

SYNOPSIS ^

    # Import the Module
    use Nagios::Status::ServiceStatus

    # Instantiate the ServiceStatus Object
    my $status = Nagios::Status::ServiceStatus->new($nagios_status_log_path);
        # OR
    my $status = Nagios::Status::ServiceStatus->new($nagios_status_log_path, $serv1, $serv2, ...);

    # Get services that are up.
    my $ok = $status->check_ok;

    # Get services that are down.
    my $warning = $status->check_warning;

    # Get services that are unreachable.
    my $unknown = $status->check_unknown;

    # Get services that are critical.
    my $critical = $status->check_critical;

DESCRIPTION ^

This module is an object oriented approach to Nagios 3.0 status services.

OBJECT CREATION METHOD ^

new
 my $status = Nagios::Status::ServiceStatus->new($nagios_status_log_path [, $serv1 .. $servN]);

This class constructs a Nagios::Status::ServiceStatus object. It requires one parameter. A file path containing the path to the Nagios status.log file. There is an optional parameter. An array of host names can be specified, whereby only those domains will be populated.

METHODS ^

check_ok
 my $servs_ok = $status->check_ok;

This method takes no parameters. It returns an array reference to all services found to be OK. Otherwise, it returns undefined.

check_warning
 my $servs_warning = $status->check_warning;

This method takes no parameters. It returns an array reference to all services found to be WARNING. Otherwise, it returns undefined.

check_unknown
 my $servs_unknown = $status->check_unknown;

This method takes no parameters. It returns an array reference to all services found to be UNKNOWN. Otherwise, it returns undefined.

check_critical
 my $servs_critical = $status->check_critical;

This method takes no parameters. It returns an array reference to all services found to be CRITICAL. Otherwise, it returns undefined.

AUTHOR ^

Roy Crowder, <rcrowder at cpan.org>

SEE ALSO ^

Nagios::Status::Service, perl, Changes

BUGS ^

Please report any bugs or feature requests to bug-nagios-status-servicestatus at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Nagios-Status-ServiceStatus. 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 Nagios::Status::ServiceStatus

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2009 WorldSpice Technologies, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: