B.19 sputil

Use this utility to perform the purge operation.

B.19.1 Syntax


B.19.2 Options

This section describes the OPTION, AOPTION, PAOPTION, and POPTION options available in the SPUTIL utility.

NOTE:The command action is irreversible.

General Options (OPTION)




Performs the purge operation by suppressing all user confirmations.


Use this option to display the total number of files that could be purged from volumes and the total space that could be reclaimed in a pool after purging.

-h, --help

Displays the help information.

Action Options (AOPTION)




Invokes the purge operation.

Purge Action Options (PAOPTION)




Lists the volume configurations.


Sets the volume configurations.


Executes the operations based on the configurations that have been preset.

NOTE:To obtain the statistics information, run --dry-run option


Removes the file extension that is configured during the set operation.

Purge Options (POPTION)



-e, --ext

Specify the file extension. It is mandatory to specify a meaningful name for the extension. If you specify “*”, “.” and so on as extension, the behavior of the operation is undefined. For example:

--ext doc --ext txt
-a, --age

Specify the age in seconds(s), minutes(m), hours(h), or days(d). Any file that is older than the specified age is purged. The default value is in days. If the value is 0, no purge action is performed. The maximum age is 49710 days. For example:

-a 30s
-a 30m
-a 20h
-a 300d
-a 0
-p, --poolname

Specify the pool name.

-v, --volname

Specify the volume name.

B.19.3 Examples

To list all the pools and volume configurations:

sputil --purge --get

To set the configuration for purge operation with the age as “250d”, file extension as “doc”, and volume name as “VOL1”:

sputil --purge --set --age 250d --ext doc --volname VOL1

NOTE:In the preceding example, the purge operation is performed if any one of the following conditions are met:

  • Files that are older than 250 days.

  • Files with “doc” extension.

To clear the configuration with file extensions as “doc” and “txt”, and volume name as “VOL1” for purge operation:

sputil --purge --clear -e doc -e txt -v VOL1

To execute the purge operation based on the configurations that have been preset:

sputil --purge --exec

To execute the purge operation for the volume “VOL1”:

sputil --purge --exec -v VOL1

To display the statistics information:

sputil --purge --exec --dry-run

This command displays only the statistic information. It does not perform the --exec operation.


  • Pool name and volume name cannot be specified together in a single command.

  • If you need to perform purge operation periodically, use crontab command.