IcingaApiSearchIdoAbstraction Class Reference

Inherits IcingaApiSearchIdo.

Collaboration diagram for IcingaApiSearchIdoAbstraction:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 getProgramDate ()
 getProgramVersion ()
 getContactgroupsByContact ($contact=false)
 getHostStatusByContactgroup ($contactgroups, $hostName=false, $hostState=false)
 getServiceStatusByContactgroup ($contactgroups, $hostName=false, $serviceName=false, $serviceState=false)
 getConfig ($key=false)
 getHostExecutionTimes ($contactgroups, $hostName=false)
 getHostLatencyTimes ($contactgroups, $hostName=false)
 getServiceExecutionTimes ($contactgroups, $hostName=false, $serviceName=false)
 getServiceLatencyTimes ($contactgroups, $hostName=false, $serviceName=false)
 getActiveHostCount ($contactgroups, $hostName=false)
 getPassiveHostCount ($contactgroups, $hostName=false)
 getHostList ()


Detailed Description

Author:
Christian Doebler <christian.doebler@netways.de>

Constructor & Destructor Documentation

IcingaApiSearchIdoAbstraction::__construct (  ) 

class constructor

Parameters:
void 
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>

Reimplemented from IcingaApiSearchIdo.


Member Function Documentation

IcingaApiSearchIdoAbstraction::getActiveHostCount ( contactgroups,
hostName = false 
)

fetches active hosts

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional; LIKE stamement)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getConfig ( key = false  ) 

fetches configuration variables and assigned values

Parameters:
string $key configuration key to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getContactgroupsByContact ( contact = false  ) 

fetches a list of contact groups

Parameters:
string $contact contact's name to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getHostExecutionTimes ( contactgroups,
hostName = false 
)

fetches host execution times (min, average, max)

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getHostLatencyTimes ( contactgroups,
hostName = false 
)

fetches host latency times (min, average, max)

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getHostList (  ) 

fetches and returns an objects containing a list of hosts

Parameters:
void 
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getHostStatusByContactgroup ( contactgroups,
hostName = false,
hostState = false 
)

fetches a list of hosts and corresponding status data

Parameters:
mixed $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
string $hostState host state to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getPassiveHostCount ( contactgroups,
hostName = false 
)

fetches number of passive hosts

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional; LIKE stamement)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getProgramDate (  ) 

fetches date information

Parameters:
void 
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getProgramVersion (  ) 

fetches version information

Parameters:
void 
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getServiceExecutionTimes ( contactgroups,
hostName = false,
serviceName = false 
)

fetches service execution times (min, average, max)

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
string $serviceName service name to use as filter (optional)
string $serviceState service state to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getServiceLatencyTimes ( contactgroups,
hostName = false,
serviceName = false 
)

fetches service latency times (min, average, max)

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
string $serviceName service name to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearchIdoAbstraction::getServiceStatusByContactgroup ( contactgroups,
hostName = false,
serviceName = false,
serviceState = false 
)

fetches a list of services and corresponding status data

Parameters:
string $contactgroups contactgroup or array of contactgroups
string $hostName host name to use as filter (optional)
string $serviceName service name to use as filter (optional)
string $serviceState service state to use as filter (optional)
Returns:
IcingaApiResult result object
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:


The documentation for this class was generated from the following file:

Generated on Fri Jul 3 08:52:13 2009 for ICINGA-API by  doxygen 1.5.8