DISK Statement—Specify Conditions to Monitor Disk Space

C-LANG Statements › DISK Statement—Specify Conditions to Monitor Disk Space

DISK Statement—Specify Conditions to Monitor Disk Space

The DISK statement specifies the conditions that a Disk Monitoring job uses to monitor the disk space of the computer where the agent is installed.

Supported Job Type

This statement is required for the Disk Monitoring job type.

Syntax

This statement has the following format:

DISK drive [FORMAT(PERCENT|GB|MB|KB|B)]
   [FROM(lower)] [TO(upper)] [NOCHANGE(value)]
   [CONTINUOUS(alertid)][WITHIN|OUTSIDE]
   [AVAILABLE|USED]

drive

Specifies the path to the disk, logical partition, or auxiliary storage pool to be monitored.

Limits: Up to 256 characters; case-sensitive

Example: /dev/QASP02

UNIX/Windows: Specify the path to the disk or logical partition to monitor.

i5/OS:

Specify the path to a file system mounted on the i5/OS operating system.
To specify the system ASP, type the forward slash (/).
To specify any other ASP, use the following format, where digit1 and digit2 indicate the ASP number:
```
/dev/QASPdigit1digit2
```

FORMAT(PERCENT|GB|MB|KB|B)

(Optional) Specifies the unit of measurement used to monitor available or used disk space. Options are the following:

PERCENT

Monitors disk usage by percentage.

Note: If you specify PERCENT, the values specified by the FROM and TO operands cannot be greater than 100.

GB

Monitors disk usage in gigabytes.

MB

Monitors disk usage in megabytes.

KB

Monitors disk usage in kilobytes.

B

Monitors disk usage in bytes. This is the default.

FROM(lower)

(Optional) Defines the lower boundary of disk usage. The unit for this value is specified in the FORMAT operand.

Limits:

0-100 (This limit applies when the disk format is PERCENT.)
Up to 10 digits (This limit applies for all other disk formats.)

Example: 35000000

Note: If you specify the FROM operand without the TO operand, the range is between the lower limit and the maximum available disk space.

TO(upper)

(Optional) Defines the upper boundary of disk usage. The unit for this value is specified in the FORMAT operand.

Limits:

0-100 (This limit applies when the disk format is PERCENT.)
Up to 10 digits (This limit applies for all other disk formats.)

Example: 36000000

Note: If you specify the TO operand without the FROM operand, the range is between zero and the upper boundary.

NOCHANGE(value)

(Optional) Defines the amount of change that the disk usage must change to trigger the alert. The unit for this value is specified in the FORMAT operand.

Limits: Up to 10 digits

Example: 100

Notes:

To use the NOCHANGE operand, specify an alert in the CONTINUOUS operand.
The alert will trigger only if the following conditions are met:
- The change value is within the range specified by the FROM and TO operands.
- The change value is greater than the delta specified by the last scanned amount. That is, the first time disk usage matches the job criteria, an alert is triggered. Subsequently, an alert is triggered only if the change in disk usage is greater than the delta calculated using the last scanned amount that was registered in a trigger.

CONTINUOUS(alertid)

(Optional) Specifies the identifier of an alert to be triggered when the specified disk monitoring conditions occur. Defines the job as continuous. To end continuous monitoring, you must complete the job manually or cancel it. If you do not specify this operand, the job completes when the specified disk monitoring conditions occur.

alertid

Specifies the alert identifier to be triggered.

Limits: 1-8 alphanumeric characters; the first character must be alphabetic

Note: The alert must have been previously defined to the scheduling manager. Not all scheduling managers support the CONTINUOUS operand.

Note: When using the CONTINUOUS operand, you must also specify the FROM operand, the TO operand, or both.

WITHIN|OUTSIDE

(Optional) Specifies whether the job completes (or triggers an alert if monitoring continuously) when the value of disk usage is within or outside the specified range.

WITHIN: Specifies that the job completes (or triggers an alert if monitoring continuously) when the value of disk usage is within the range specified by the FROM and TO operands. This is the default.
OUTSIDE: Specifies that the job completes (or triggers an alert if monitoring continuously) when the value of disk usage is outside the range specified by the FROM and TO operands.

AVAILABLE|USED

(Optional) Specifies whether the job monitors available or used disk space.

AVAILABLE: Specifies that the job reads the available disk space for monitoring. This is the default.
USED: Specifies that the job reads the used disk space for monitoring.

Notes:

Enclose values that contain delimiters (such as spaces) in double quotation marks.
The FROM, TO, NOCHANGE, CONTINUOUS, WITHIN, OUTSIDE, AVAILABLE, and USED operands do not apply when the WAITMODE statement is set to NOW.

Example: Monitor Available Space on a UNIX Partition

This example monitors a local UNIX partition for available space. The job completes immediately and reports the available space in megabytes.

AGENT UNIXAGENT
DISK /export/home FORMAT(MB)

Example: Continuously Monitor Used Space on a UNIX Partition

This example continuously monitors used disk space on a local UNIX partition. Each time the used disk space falls between 90 and 100 percent, an alert named DISK is issued. The job continues monitoring the disk space until it is ended manually.

AGENT UNIXAGENT
DISK /export/home FORMAT(PERCENT) FROM(90) USED +

CONTINUOUS(DISK)

Example: Continuously Monitor Used Space on a Windows Drive

This example continuously monitors the C drive on a Windows computer for used space. Each time the used disk space falls below 16 percent or exceeds 95 percent, an alert named DISK is triggered. The job continues monitoring the disk space until it is ended manually.

AGENT WINAGENT
DISK C FORMAT(PERCENT) FROM(16) TO(95) USED OUTSIDE +

CONTINUOUS(DISK)

Example: Monitor for a Change in Disk Usage Greater than 100 KB

This example continuously monitors the available disk space in kilobytes (KB) on the local Windows C drive. When the available space is in the 35000000 to 36000000 KB range, the first alert is triggered.

Subsequently, an alert is triggered each time the available disk space is within the specified boundaries and the disk usage changes by more than 100 KB. If the amount of change is less than or equal to 100 KB, the job does not register a change.

AGENT WINAGENT
DISK C FORMAT(KB) FROM(35000000) TO(36000000) NOCHANGE(100)+

CONTINUOUS(disk)

The following table shows four sequential scans:

Scan	Scanned Amount (Kilobytes)	Does the trigger occur?
1	35018896	Yes.
2	35018900	No. Comparing scan 2 to scan 1, the delta value is only 4 KB. This scanned amount will not be included in the next calculation.
3	35018795	Yes. Comparing scan 3 to scan 1, the delta value is greater than 100 KB. The delta value of the next scan will be calculated using the scan 3 value of 35018795.
4	36000001	No. The scanned amount is outside the range specified by the FROM and TO operands.

Example: Monitor the System Auxiliary Storage Pool on an i5/OS System

This example continuously monitors the system auxiliary storage pool for used disk space. Each time the used disk space falls between 90 and 100 percent, an alert named DISK is triggered. The job continues monitoring the disk space until it is ended manually.

AGENT I5AGENT
DISK / FORMAT(PERCENT) FROM(90) TO(100) USED CONTINUOUS(DISK)