NAME

ASNMTAP::Asnmtap is an object-oriented Base Class to build modules that provides a nice object oriented interface for ASNMTAP.

SYNOPSIS

use ASNMTAP::Asnmtap;

my $objectAsnmtap = ASNMTAP::Asnmtap->new (
  _programName        => 'test-asnmtap.pl',
  _programDescription => "Test ASNMTAP::Asnmtap",
  _programVersion     => '3.002.003',
  _programUsagePrefix => '[--commandLineOption]',
  _programHelpPrefix  => "--commandLineOption ...",
  _programGetOptions  => ['commandLineOption=s'],
  _timeout            => 30,
  _debug              => 1);

my $verbose = $objectAsnmtap->getOptionsArgv ('verbose');
print "getOptionsArgv: verbose = $verbose\n" if (defined $verbose);

my $dumpData = $objectAsnmtap->getOptionsArgv ('dumpData');
$objectAsnmtap->dumpData () if (defined $dumpData);

my $commandLineOption = $objectAsnmtap->getOptionsArgv ('commandLineOption');
print "getOptionsArgv : commandLineOption = $commandLineOption\n" if (defined $commandLineOption);

DESCRIPTION

Once Upon a Time in Belgium there was an ape called ...

OVERVIEW OF CLASSES AND PACKAGES

OVERVIEW OF CLASSES

ASNMTAP::Asnmtap

Is an object-oriented Base Class to build modules that provides a nice object oriented interface for ASNMTAP.

ENVIRONMENT

PERL5LIB: A colon-separated list of directories in which to look for Perl library files before looking in the standard library and the current directory.
ASNMTAP_PERL5LIB: A colon-separated list of directories in which to look for Perl library files before looking in the standard library and the current directory.

ASNMTAP::Asnmtap::Applications

Is a Perl module that provides a nice object oriented interface for ASNMTAP Applications

Subclass of ASNMTAP::Asnmtap

ASNMTAP::Asnmtap::Applications::CGI

Is a Perl module that provides a nice object oriented interface for ASNMTAP CGI Applications

Subclass of ASNMTAP::Asnmtap::Applications

ASNMTAP::Asnmtap::Applications::Collector

Is a Perl module that provides a nice object oriented interface for ASNMTAP Collector Applications

Subclass of ASNMTAP::Asnmtap::Applications

ASNMTAP::Asnmtap::Applications::Display

Is a Perl module that provides a nice object oriented interface for ASNMTAP Display Applications

Subclass of ASNMTAP::Asnmtap::Applications

ASNMTAP::Asnmtap::Plugins

This module that provides a nice object oriented interface for building ASNMTAP (http://asnmtap.citap.be) compatible plugins.

Subclass of ASNMTAP::Asnmtap

ASNMTAP::Asnmtap::Plugins::Nagios

This module that provides a nice object oriented interface for building Nagios (http://www.nagios.org) compatible plugins.

Subclass of ASNMTAP::Asnmtap::Plugins

PACKAGES

ASNMTAP::Time: Is a Perl module that provides date and time functions used by ASNMTAP and ASNMTAP-based applications and plugins.
ASNMTAP::Asnmtap::Plugins::IO: Is a Perl module that provides IO functions used by ASNMTAP-based plugins.
ASNMTAP::Asnmtap::Plugins::Mail: Is a Perl module that provides Mail functions used by ASNMTAP-based plugins.
ASNMTAP::Asnmtap::Plugins::Modem: Is a Perl module that provides Modem functions used by ASNMTAP-based plugins.
ASNMTAP::Asnmtap::Plugins::SOAP: Is a Perl module that provides SOAP functions used by ASNMTAP-based plugins.
ASNMTAP::Asnmtap::Plugins::WebTransact: Is an object-oriented class for generating ASNMTAP-based plugins of Web Transactions.
ASNMTAP::Asnmtap::Plugins::XML: Is a Perl module that provides XML functions used by ASNMTAP-based plugins.

OVERVIEW OF CONSTANTS

$APPLICATION       Application Monitoring
$BUSINESS          CITAP
$DEPARTMENT        Development
$COPYRIGHT         2003-2011
$SENDEMAILTO       alex.peeters@citap.be
$TYPEMONITORING    central # central or distributed
$RUNCMDONDEMAND    localhost # localhost or probe

$CAPTUREOUTPUT     1 # 1 -> capture_exec($system_action) or 0 -> system ($system_action)

$PREFIXPATH        /opt/asnmtap-3.001.xxx
$APPLICATIONPATH   $PREFIXPATH/applications
$PLUGINPATH        $PREFIXPATH/plugins
$LOGPATH           $PREFIXPATH/log
$PIDPATH           $PREFIXPATH/pid

$CHATCOMMAND       /usr/sbin/chat
$DIFFCOMMAND       /usr/bin/diff
$KILLALLCOMMAND    /usr/bin/killall
$PERLCOMMAND       /usr/bin/perl
$PPPDCOMMAND       /usr/sbin/pppd
$ROUTECOMMAND      /sbin/route
$RSYNCCOMMAND      /usr/bin/rsync
$SCPCOMMAND        /usr/bin/scp
$SSHCOMMAND        /usr/bin/ssh

%ERRORS            'OK'          => '0'
                   'WARNING'     => '1'
                   'CRITICAL'    => '2'
                   'UNKNOWN'     => '3'
                   'DEPENDENT'   => '4'
                   'OFFLINE'     => '5'
                   'NO TEST'     => '6'
                   'NO DATA'     => '7'
                   'IN PROGRESS' => '8'
                   'TRENDLINE'   => '9'

%STATE             '0' => 'OK'
                   '1' => 'WARNING'
                   '2' => 'CRITICAL'
                   '3' => 'UNKNOWN'
                   '4' => 'DEPENDENT'
                   '5' => 'OFFLINE'
                   '6' => 'NO TEST'
                   '7' => 'NO DATA'
                   '8' => 'IN PROGRESS'
                   '9' => 'TRENDLINE'

%TYPE              'REPLACE'       => '0'
                   'APPEND'        => '1'
                   'INSERT'        => '2'
                   'COMMA_REPLACE' => '3' # <- reserved !!!
                   'COMMA_APPEND'  => '4'
                   'COMMA_INSERT'  => '5'

CONFIG

You can change the values for the CONSTANTS by use of an config file 'Asnmtap.cnf'.

The default location for the config file is into the root for ASNMTAP-based applications and plugins '/opt/asnmtap'.

With the environment variable ASNMTAP_PATH you can change the default location for ASNMTAP-based applications and plugins.

Example Asnmtap.cnf

# SET ENVIRONMENT VARIABLES - - - - - - - - - - - - - - - - - - - - -
<ENV>
    PATH               /usr/bin:/bin:/usr/sbin:/sbin
    BASH_ENV
    ENV
</ENV>

<SET>
    PERL5LIB			/opt/asnmtap/cpan-shared/lib/perl5
    MANPATH			/opt/asnmtap/cpan-shared/share/man
    LD_LIBRARY_PATH	/opt/asnmtap/ssl/lib
</SET>

# Common variables  - - - - - - - - - - - - - - - - - - - - - - - - -
<COMMON>
    APPLICATION        Application Monitoring
    BUSINESS           CITAP
    DEPARTMENT         Development
    COPYRIGHT          2003-2011
    SENDEMAILTO        alex.peeters@citap.be
    TYPEMONITORING     central
    RUNCMDONDEMAND     probe
</COMMON>

<COMMAND>
    CHAT               /usr/sbin/chat
    DIFF               /usr/bin/diff
    KILLALL            /usr/bin/killall
    PPPD               /usr/sbin/pppd
    PERL               /usr/bin/perl
    ROUTE              /sbin/route
    RSYNC              /usr/bin/rsync
    SCP                /usr/bin/scp
    SSH                /usr/bin/ssh
</COMMAND>

<IO>
    CAPTUREOUTPUT      1
</IO>

# -------------------------------------------------------------------
# DON'T TOUCH BELOW HERE UNLESS YOU KNOW WHAT YOU ARE DOING!
# -------------------------------------------------------------------

<SUBDIR>
    APPLICATIONS       applications
    PLUGINS            plugins
    LOG                log
    PID                pid
    RUN                run
</SUBDIR>

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ATTRIBUTES

_programName

required, scalar, the program name, default: 'NOT DEFINED'

_programDescription

required, scalar, the program description, default: 'NOT DEFINED'

_programVersion

required, scalar, the program version, default: '0.000.000'

_programUsagePrefix

optional, scalar, the program usage prefix, default: undef

_programHelpPrefix

optional, scalar, the program help prefix, default: undef

_programUsageSuffix

scalar, the program predifined usage suffix

[-v|--verbose <LEVEL>]
[-V|--version]
[-h|--help]
[--usage]
[--dumpData]

_programHelpSuffix

scalar, the program predifined help suffix

-v, --verbose=<LEVEL>
   0: single line, minimal output.
   1: single line, additional information
   2: multi line, configuration debug output
   3: lots of detail for plugin problem diagnosis
-V, --version
   Report version
-h, --help
   Display the help message
--usage
   Display the short usage statement
--dumpData
   Display the stringified data structures from the current object

_programGetOptions

array, the program command line option specifier defines the name of the predefined and optionally options

predifined: 'verbose|v:i', 'vervion|V', 'help|h', 'usage', 'dumpData'

_getOptionsArgv

scalar, the program command line entered options returned values (the equivalent of the assignment)

_getOptionsValues

there are no get options values defined for ASNMTAP::Asnmtap

_getOptionsType

there are no get options types defined for ASNMTAP::Asnmtap

_debug

set object debuging on or off

scalar, 0 set 'debug off' (default) and 1 set 'debug on'

METHODS

Object accessor methods

programName()

Arguments (optional): scalar, program name
Function: Set and/or get the program name

programDescription()

Arguments (optional): scalar, program description
Function: Set and/or get the program description

programVersion()

Arguments (optional): scalar, program version
Function: Set and/or get the program version

getOptionsArgv()

Arguments

item: scalar, get option argv

Function

Get the get options argv for item

Return

returned the get option argv value or undef when item doesn't exist

Example

my $objectAsnmtap = ASNMTAP::Asnmtap->new (
  ...
  _programUsagePrefix => '[--dumpData] [--commandLineOption]',
  _programHelpPrefix  => "--dumpData ...
--commandLineOption ...",
  _programGetOptions => ['dumpData', 'commandLineOption=s'],
  ...
);

my $dumpData = $objectAsnmtap->getOptionsArgv('dumpData');

my $commandLineOption = $objectAsnmtap->getOptionsArgv('commandLineOption');

getOptionsValue()

Arguments: item: scalar, get option value
Function: Get the option value for item
Return: returned the get option value or undef when item doesn't exist

getOptionsType()

Arguments

item: scalar, get option type

Function

Get the option type for item

Supported items for ASNMTAP::Asnmtap are: status, asnmtapEnv, onDemand, logging, debugfile and debug
Supported items for ASNMTAP::Asnmtap::Plugins are: timeout, trendline, environment, proxy, host, url, port, community, username, password, filename, interval, loglevel, year, quarter, month, warning and critical
Supported items for ASNMTAP::Asnmtap::Plugins::Nagios are: ostype and metric

Return

returned the get option type (':' or '=') or undef when item doesn't exist

debug()

Arguments (optional): scalar, 0 = debug off and 1 = debug on
Function: Set and/or get package ASNMTAP::Asnmtap debug value

Class accessor methods

dumpData()

Arguments (optional): debug, scalar
Function: Stringified the data structures from the current object when _debug => 1 or argument debug = 1

Utility methods

printRevision()

Arguments (optional): exit: scalar, 1
Function: Print revision function when command arguments are -V or --version
Return: exit 'UNKNOWN' when exit argument exists for ASNPTAP::Plugins and inherits, otherwise exit 0

printUsage()

Arguments (optional): usage: scalar, description
Function: Print usage function
Return: exit 'UNKNOWN' when usage argument exists for ASNPTAP::Plugins and inherits, otherwise exit 0

printHelp()

Arguments (none)
Function: Print help function when command arguments are -h or --help
Return: exit 'UNKNOWN' for ASNPTAP::Plugins and inherits, otherwise exit 0

call_system()

Arguments: command, scalar
Function: system call for command
Return: returns success, stdout and stderr

EXPORT

AUTHOR

Alex Peeters [alex.peeters@citap.be]

DEPENDENCIES

Carp
Config::General
Data::Dumper 
Dumpvalue
Getopt::Long
IO::CaptureOutput
Test::Pod::Coverage
Test::Simple
Time::Local

COPYRIGHT NOTICE

ASNMTAP is based on 'Process System daemons v1.60.17-01', Alex Peeters [alex.peeters@citap.be]

Purpose: CronTab (CT, sysdCT),
         Disk Filesystem monitoring (DF, sysdDF),
         Intrusion Detection for FW-1 (ID, sysdID)
         Process System daemons (PS, sysdPS),
         Reachability of Remote Hosts on a network (RH, sysdRH),
         Rotate Logfiles (system activity files) (RL),
         Remote Socket monitoring (RS, sysdRS),
         System Activity monitoring (SA, sysdSA).

'Process System daemons' is based on 'sysdaemon 1.60' written by Trans-Euro I.T Ltd

LICENSE

This ASNMTAP CPAN library and Plugin templates are free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The other parts of ASNMTAP may be used and modified free of charge by anyone so long as this copyright notice and the comments above remain intact. By using this code you agree to indemnify Alex Peeters from any liability that might arise from it's use.

Selling the code for this program without prior written consent is expressly forbidden. In other words, please ask first before you try and make money off of my program.

Obtain permission before redistributing this software over the Internet or in any other medium. In all cases copyright and header must remain intact.

To install ASNMTAP::Time, copy and paste the appropriate command in to your terminal.

cpanm

cpanm ASNMTAP::Time

CPAN shell

perl -MCPAN -e shell
install ASNMTAP::Time

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

OVERVIEW OF CLASSES AND PACKAGES

OVERVIEW OF CLASSES

PACKAGES

OVERVIEW OF CONSTANTS

CONFIG

Example Asnmtap.cnf

ATTRIBUTES

METHODS

Object accessor methods

Class accessor methods

Utility methods

EXPORT

TAGS

AUTHOR

SEE ALSO

DEPENDENCIES

COPYRIGHT NOTICE

LICENSE

NAME

SYNOPSIS

DESCRIPTION

OVERVIEW OF CLASSES AND PACKAGES

OVERVIEW OF CLASSES

PACKAGES

OVERVIEW OF CONSTANTS

CONFIG

Example Asnmtap.cnf

ATTRIBUTES

METHODS

Object accessor methods

Class accessor methods

Utility methods

EXPORT

TAGS

AUTHOR

SEE ALSO

DEPENDENCIES

COPYRIGHT NOTICE

LICENSE

Module Install Instructions