OMVMonit Class Reference

Inheritance diagram for OMVMonit:

Public Member Functions
	setGroup ($value)
	start ($name, $quiet=FALSE)
	stop ($name, $quiet=FALSE)
	restart ($name, $quiet=FALSE)
	monitor ($name, $quiet=FALSE)
	unmonitor ($name, $quiet=FALSE)
	update ()
	status ($name)
Public Member Functions inherited from OMVObject
	__construct ()
	getLastError ()

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)
	debug ()

Detailed Description

This file is part of OpenMediaVault.

License:

http://www.gnu.org/licenses/gpl.html GPL Version 3

Author

Volker Theile volke.nosp@m.r.th.nosp@m.eile@.nosp@m.open.nosp@m.media.nosp@m.vaul.nosp@m.t.org

Copyright

Copyright (c) 2009-2014 Volker Theile

OpenMediaVault is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

OpenMediaVault is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with OpenMediaVault. If not, see http://www.gnu.org/licenses/.

Member Function Documentation

OMVMonit::monitor	(		$name,
			$quiet = FALSE
	)

Enable monitoring of the named service.

Parameters

name	The name of the service.
quiet	Do not throw an error on failure. Defaults to FALSE.

Returns

None

OMVMonit::restart	(		$name,
			$quiet = FALSE
	)

Restart the named service.

Parameters

name	The name of the service.
quiet	Do not throw an error on failure. Defaults to FALSE.

Returns

None

OMVMonit::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

value

Set to TRUE to use the group option, otherwise FALSE.

Returns

None

OMVMonit::start	(		$name,
			$quiet = FALSE
	)

Start the named service and enable monitoring for it.

Parameters

name	The name of the service.
quiet	Do not throw an error on failure. Defaults to FALSE.

Returns

None

OMVMonit::status

(

$name

)

Get the status of a monitored process.

Parameters

name	The name of the service.

Returns

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

OMVMonit::stop	(		$name,
			$quiet = FALSE
	)

Stop the named service and disable its monitoring.

Parameters

name	The name of the service.
quiet	Do not throw an error on failure. Defaults to FALSE.

Returns

None

OMVMonit::unmonitor	(		$name,
			$quiet = FALSE
	)

Disable monitoring of the named service.

Parameters

name	The name of the service.
quiet	Do not throw an error on failure. Defaults to FALSE.

Returns

None

OMVMonit::update

(

)

Create the monit configuration and reinitialize monit.

---

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

• monit.inc