/ 
Nagios-Plugin-OverHTTP-0.15
River stage zero No dependents
/ Nagios::Plugin::OverHTTP::Library

NAME

Nagios::Plugin::OverHTTP::Library - Types library for Nagios::Plugin::OverHTTP

VERSION

This documentation refers to Nagios::Plugin::OverHTTP::Library version 0.15

SYNOPSIS

use Nagios::Plugin::OverHTTP::Library qw(URL);
# This will import URL type into your namespace as well as some helpers
# like to_URL and is_URL. See MooseX::Types for more information.

DESCRIPTION

This module provides types for Nagios::Plugin::OverHTTP

METHODS

No methods.

TYPES PROVIDED

Hostname

This specifies a hostname. This is validated using the Data::Validate::Domain library with the is_hostname function.

HTTPVerb

Added in version 0.12; be sure to require this version for this feature.

This specifies a HTTP verb. THis must be in all capital letters and all verbs are valid.

Path

This specifies a valid URL path. Currently this is just a string that must begin with a forward slash. A coercion exists that will add a forward slash to the beginning of the string if there is not one.

Status

This specifies a valid Nagios service status code. The status code must be a valid number. This type also provides a coercion from a string. The string is not case-sensitive and may be one of the following values:

  • OK

  • WARNING

  • CRITICAL

  • UNKNOWN

Timeout

This specifies a valid timeout value. A timeout value is an integer that is greater than zero.

URL

This specifies a URL. This is a string and is validated using the Data::Validate::URI library with the is_uri function.

CONSTANTS PROVIDED

$STATUS_OK

Represents a status of OK.

$STATUS_WARNING

Represents a status of warning.

$STATUS_CRITICAL

Represents a status of critical.

$STATUS_UNKNOWN

Represents a status of unknown.

DEPENDENCIES

This module is dependent on the following modules:

AUTHOR

Douglas Christopher Wilson, <doug at somethingdoug.com>

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-nagios-plugin-overhttp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Nagios-Plugin-OverHTTP. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

LICENSE AND COPYRIGHT

Copyright 2009 Douglas Christopher Wilson, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of either:

  • the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or

  • the Artistic License version 2.0.