openmediavault  4.0 (Arrakis)
The open network attached storage solution
Public Member Functions | List of all members
OMV\System\Monit Class Reference

Public Member Functions

 __construct ($name)
 
 setGroup ($value)
 
 start ($quiet=FALSE)
 
 stop ($quiet=FALSE)
 
 restart ($quiet=FALSE)
 
 monitor ($quiet=FALSE)
 
 unmonitor ($quiet=FALSE)
 
 update ()
 
 status ()
 
 isRunning ()
 

Constructor & Destructor Documentation

◆ __construct()

OMV\System\Monit::__construct (   $name)

Constructor

Parameters
nameThe name of the service.

Member Function Documentation

◆ isRunning()

OMV\System\Monit::isRunning ( )

Check whether the specified service is running.

Returns
TRUE if the service is running, otherwise FALSE.

◆ monitor()

OMV\System\Monit::monitor (   $quiet = FALSE)

Enable monitoring of the named service.

Parameters
quietDo not throw an error on failure. Defaults to FALSE.
Returns
None

◆ restart()

OMV\System\Monit::restart (   $quiet = FALSE)

Restart the named service.

Parameters
quietDo not throw an error on failure. Defaults to FALSE.
Returns
None

◆ setGroup()

OMV\System\Monit::setGroup (   $value)
final

Set the group option. If set, then the methods start, stop, restart, monitor and unmonitor will be applied to the given group name.

Parameters
valueSet to TRUE to use the group option, otherwise FALSE.
Returns
None

◆ start()

OMV\System\Monit::start (   $quiet = FALSE)

Start the named service and enable monitoring for it.

Parameters
quietDo not throw an error on failure. Defaults to FALSE.
Returns
None

◆ status()

OMV\System\Monit::status ( )

Get the status of a monitored process.

Returns
The status of the monitored service, e.g. 'running', 'does not exist' or 'not monitored'.

◆ stop()

OMV\System\Monit::stop (   $quiet = FALSE)

Stop the named service and disable its monitoring.

Parameters
quietDo not throw an error on failure. Defaults to FALSE.
Returns
None

◆ unmonitor()

OMV\System\Monit::unmonitor (   $quiet = FALSE)

Disable monitoring of the named service.

Parameters
quietDo not throw an error on failure. Defaults to FALSE.
Returns
None

◆ update()

OMV\System\Monit::update ( )

Create the monit configuration and reinitialize monit.


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