ASNMTAP
67 results

 view release on metacpan or  search on metacpan

lib/ASNMTAP/Asnmtap/Plugins.pod  view on Meta::CPAN 

    F(alse)       : nok file debugging off (default)
    T(true)       : nok file debugging on
 -O, --onDemand=F|T|N|Y
    F(alse)/N(o)  : normal plugin execution (default)
    T(true)/Y(es) : plugin launched on demand
 -L, --logging=<LOGGING>
    write logging to file <LOGGING>
 -D, --debugfile=<DEBUGFILE>
    write debug to file <DEBUGFILE>
 -d, --debug=F|T|L|M|A|S
    F(alse)       : screendebugging off (default)
    T(true)       : normal screendebugging on
    L(ong)        : long screendebugging on
    M(oderator)   : long screendebugging on for Moderators
    A(dmin)       : long screendebugging on for Admins
    S(erver Admin): long screendebugging on for Server Admins

=item reserved command line options (autoinsertions)

 -t, --timeout=<TIMEOUT>

    timeout threshold (seconds) from which an UNKNOWN status will result when timing out slow plugins

    add: new ... (_programGetOptions => ['timeout|t:i' or 'timeout|t=i'])

    autoadd [-t|--timeout <TIMEOUT>] to _programUsageSuffix

    autoadd -t, --timeout=<TIMEOUT> ... to _programHelpSuffix

 -T, --trendline=<TRENDLINE>

    trendline threshold (seconds) from which a TRENDLINE status will result for the plugin response time

    add: new ... (_programGetOptions => ['trendline|T:i' or trendline|T=i'])

    autoadd [-T|--trendline <TRENDLINE>] to _programUsageSuffix

    autoadd -T, --trendline=<TRENDLINE> ..0 to _programHelpSuffix

 -e, --environment=<ENVIRONMENT>

    P(roduction)  and set the _getOptionsValues to 'Production'
    S(imulation)  and set the _getOptionsValues to 'Simulation'
    A(cceptation) and set the _getOptionsValues to 'Acceptation'
    T(est)        and set the _getOptionsValues to 'Test'
    D(evelopment) and set the _getOptionsValues to 'Development'
    L(ocal)       and set the _getOptionsValues to 'Local'

    add: new ... (_programGetOptions => ['environment|e:s' or 'environment|e=s'])

    autoadd [--environment <ENVIRONMENT>] to _programUsageSuffix

    autoadd --environment=<ENVIRONMENT>
               P(roduction)
               S(imulation)
               A(cceptation)
               T(est)
               D(evelopment)
               L(ocal) to _programHelpSuffix

 --proxy=<username:password@proxy:port&domain[,domain]>

    add: new ... (_programGetOptions => ['proxy:s' or 'proxy=s'])

    autoadd [--proxy <username:password@proxy:port&domain[,domain]>] to _programUsageSuffix

    autoadd --proxy=<username:password@proxy:port&domain[,domain]> to _programHelpSuffix

 -H, --host=<HOST>

    hostname or ip address

    add: new ... (_programGetOptions => ['host|H:s' or 'host|H=s'])

    autoadd [-H|--host <HOST>] to _programUsageSuffix

    autoadd -H,--host=<HOST> to _programHelpSuffix

 -U, --url=<URL>

    add: new ... (_programGetOptions => ['url|U:s' or 'url|U=s'])

    autoadd [-U|--url <URL>] to _programUsageSuffix

    autoadd -U, --url=<URL> to _programHelpSuffix

 -P, --port=<PORT>

    add: new ... (_programGetOptions => ['port|P:i' or 'port|P=i'])

    autoadd [-P|--port <PORT>] to _programUsageSuffix

    autoadd -P, --port=<PORT> to _programHelpSuffix

 -C, --community=<SNMP COMMUNITY>

   _programUsagePrefix: [-C|--community <SNMP COMMUNITY>]

    add: new ... (_programGetOptions => ['community|C:s' or 'community|C=s'])

    autoadd [-C|--community <SNMP COMMUNITY>] to _programUsageSuffix

    autoadd -C, --community=<SNMP COMMUNITY> to _programHelpSuffix

 -u, --username/--loginname=<USERNAME>

    add: new ... (_programGetOptions => ['username|u|loginname:s' or 'username|u|loginname=s'])

    autoadd [-u|--username|--loginname <USERNAME>] to _programUsageSuffix

    autoadd -u, --username/--loginname=<USERNAME> to _programHelpSuffix

 -p, --password/--passwd=<PASSWORD>

    add: new ... (_programGetOptions => ['password|p|passwd:s' or 'password|p|passwd=s'])

    autoadd [-p|--password|--passwd <PASSWORD>] to _programUsageSuffix

    autoadd -p, --password/--passwd=<PASSWORD> to _programHelpSuffix

 -F, --filename=<FILENAME>

    XML filename with the ASNMTAP/Nagios compatible test results

    add: new ... (_programGetOptions => ['filename|F:s' or 'filename|F=s'])

    autoadd [-F|--filename <FILENAME>] to _programUsageSuffix

    autoadd -F, --filename=<FILENAME> ... to _programHelpSuffix

 -i, --interval=<SECONDS>

    interval threshold (seconds) from which a CRITICAL (2x) or WARNING (1x) status will result when XML fingerprint out of time

    add: new ... (_programGetOptions => ['interval|i:i' or 'interval|i=i'])

    autoadd [-i|--interval <SECONDS>] to _programUsageSuffix

    autoadd -i, --interval=<SECONDS> ... to _programHelpSuffix

-l, --loglevel=<LOGLEVEL>

    loglevel, one of (order of decrescent verbosity): debug, verbose, notice, info, warning, err, crit, alert, emerg

    add: new ... (_programGetOptions => ['loglevel|l:s' or 'loglevel|l=s'])

    autoadd [-l|--loglevel <LOGLEVEL>] to _programUsageSuffix

    autoadd -l, --loglevel=<LOGLEVEL> ... to _programHelpSuffix

-Y, --year=<YEAR>

    year, format: [19|20|21]yy

    add: new ... (_programGetOptions => ['year|i:i' or 'year|i=i'])

    autoadd [-Y|--year <YEAR>] to _programUsageSuffix

    autoadd -Y, --year=<YEAR> ... to _programHelpSuffix

-Q, --quarter=<QUARTER>

    quarter, where value 1..4

    add: new ... (_programGetOptions => ['quarter|Q:i' or 'quarter|Q:i'])

    autoadd [-Q|--quarter <QUARTER>] to _programUsageSuffix

    autoadd -Q, --quarter=<QUARTER> ... to _programHelpSuffix

-M, --month=<MONTH>

    month, where value 1..12

    add: new ... (_programGetOptions => ['month|M:i' or 'month|M=i'])

    autoadd [-M|--month <MONTH>] to _programUsageSuffix

    autoadd -M, --month=<MONTH> ... to _programHelpSuffix

lib/ASNMTAP/Asnmtap/Plugins.pod  view on Meta::CPAN 


=item _browseragent

specifies the name that your application should use when it presents itself on the network.

scalar, default 'Mozilla/5.0 (compatible; ASNMTAP; U; ASNMTAP 3.002.003 postfix; nl-BE; rv:3.002.003) Gecko/yyyymmdd libwww-perl/5.813'

=item _SSLversion

the value of the SSL version, 2, 3 or 23, default 3

  Crypt::SSLeay tries very hard to connect to ANY SSL web server trying to accomodate servers that are buggy, old or simply not standards compliant.

  To this effect, this module will try SSL connections in this order:
  - SSL v23 - should allow v2 & v3 servers to pick their best type
  - SSL v3  - best connection type
  - SSL v2  - old connection type

=item _clientCertificate: the following keys are possible

=over 4

=item certFile

CLIENT CERT SUPPORT, PEM encoded certificate file.

=item keyFile

CLIENT CERT SUPPORT, PEM encoded private key file.

=item caFile

CA CERT PEER VERIFICATION

=item caDir

Additionally, if you would like to tell the client where the CA file is.

=item pkcs12File

CLIENT PKCS12 CERT SUPPORT, Use of this type of certificate will take precedence over previous certificate settings described.

=item pkcs12Password

PKCS12 PASSWORD

=back

=item _proxy: the following keys are possible

=over 4

=item server

the name of the server and optional port number

=item username

the username

=item password

the password

=item no

do not proxy requests to the given domains. Calling no_proxy without any domains clears the list of domains.

=back

=item _timeout

specifies how much time we give remote servers to respond before the library disconnects and creates an internal timeout response.

scalar, default 10

=back

=head1 INHERITS from ASNMTAP::Asnmtap

=head2 Attributes

_programName
_programDescription
_programVersion
_programUsagePrefix
_programHelpPrefix
_programGetOptions
_debug

=head2 Object accessor methods

programName()
programDescription()
programVersion()

getOptionsArgv()
getOptionsValue()

debug()

=head2 Class accessor methods

dumpData()

=head2 Utility methods

printRevision()
printUsage()
printHelp()

get_yyyymmddhhmmsswday()

get_datetimeSignal()
get_datetime()

get_logfiledate()
get_csvfiledate()
get_csvfiletime()

get_epoch()
get_week()
get_wday()

lib/ASNMTAP/Asnmtap/Plugins.pod  view on Meta::CPAN 


=item error

set the error message

optional, scalar

=item result

set the result to the object

optional, scalar

=back

=item replace/append

  0: replace alert and/or error
  1: append to alert and/or error
  2: insert to alert and/or error
  3: add comma and replace alert and/or error
  4: add comma and append to alert and/or error
  5: add comma and insert to alert and/or error
 
  %TYPE = ( REPLACE => 0, APPEND => 1, INSERT => 2, COMMA_REPLACE => 3, COMMA_APPEND => 4, COMMA_INSERT => 5 )

=back

=item Function

Set and/or get the plugin values for the required arguments

=back

=item proxy()

=over 4

=item Arguments

=over 4

=item item

scalar, set and/or get a proxy value

item is equal to one of the possible items:

=over 4

=item server

  $objectPlugins->proxy( 'server' => 'proxy.citap.com' );
  $objectPlugins->_init_proxy_and_client_certificate ();

=item username

  $objectPlugins->proxy( 'username' => 'username' );
  $objectPlugins->_init_proxy_and_client_certificate ();

=item password

  $objectPlugins->proxy( 'password' => 'password' );
  $objectPlugins->_init_proxy_and_client_certificate ();

=item no

  $objectPlugins->proxy( 'no' => ['localhost', '127.0.0.1'] );
  $objectPlugins->_init_proxy_and_client_certificate ();

=back

=item value (optional)

scalar, the value to set

=back

=item Function

Set and/or get the plugin value for item

=back

=item timeout()

=over 4

=item Arguments (optional)

scalar, timeout value

=item Function

Set and/or get the timeout value

=back

=item write_debugfile()

=over 4

=item Arguments

parameter 1: scalar reference, debug
parameter 2: scalar, open debugfile as 'Writes, Appends, and Creates' mode when 1, otherwise open debugfile in 'Creates, Writes, and Truncates' mode.

=item Function

Write debug to file DEBUGFILE, specified with the command line options '-D, --debugfile=DEBUGFILE'

=back

=back

=head2 Class accessor methods

=over 4

=item setEndTime_and_getResponsTime()

=over 4



( run in 0.793 second using v1.01-cache-2.11-cpan-5837b0d9d2c )