This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with Mac OS X Server. It is not available on standard Mac OS X (client) installations.

For more information about the manual page format, see the manual page for manpages(5).

diskspacemonitor(8)       BSD System Manager's Manual      diskspacemonitor(8)

NAME
     diskspacemonitor -- Mac OS X Server disk space monitoring facility

SYNOPSIS
     diskspacemonitor [on | off | status | check]

DESCRIPTION
     diskspacemonitor is a fully configurable, launchd activated facility to periodically monitor the amount
     of free space on disks and take pre-configured actions when thresholds are exceeded.

     In typical usage, diskspacemonitor is enabled by running "sudo diskspacemonitor on".

OPTIONS
     on - enables the mechanism by adding a launchd task

     off - disables the mechanism by deleting the unloading and disabling the launchd task

     status - shows whether the mechanism is enabled, and the monitor interval, if it is (value returned is
     in minutes).

     check - performs the configured checking operations. This is normally invoked by the launchd task at
     the specified monitor interval.

CONFIGURATION
     diskspacemonitor is driven by config file:

     /etc/diskspacemonitor/diskspacemonitor.conf

     diskspacemonitor executes alert and recovery scripts in:

     /etc/diskspacemonitor/action/

     Two pre-defined scripts are provided:

     /etc/diskspacemonitor/action/alert, to alert the administrator that a warning threshold is exceeded,
     and

     /etc/diskspacemonitor/action/recover, to recover disk space by compressing, rolling, and deleting log
     files.

     These scripts are also driven by config files:

     /etc/diskspacemonitor/alert.conf
     /etc/diskspacemonitor/recover.conf


     Administrators may add their own scripts:

     /etc/diskspacemonitor/action/alert.local
     /etc/diskspacemonitor/action/recover.local

     These will be invoked at the respective disk space thresholds before the standard scripts are invoked.

FILES & FOLDERS
     /usr/sbin/diskspacemonitor
     /etc/diskspacemonitor/diskspacemonitor.conf
     /etc/diskspacemonitor/recover.conf
     /etc/diskspacemonitor/alert.conf
     /etc/diskspacemonitor/action/recover
     /etc/diskspacemonitor/action/alert
     /var/log/diskspacemonitor.log
     /System/Library/LaunchDaemons/com.apple.diskspacemonitor.plist

Mac OS X Server                   16 Jun 2002                  Mac OS X Server