Manage quotas using the CLI

This page describes how to manage quotas using the CLI.

Using the CLI, you can:

• Set default quota

• Set directory quota

• List directory quotas/default quotas

• Unset default quota

• Reset directory quota

Set default quota

Command: weka fs quota set-default

Before using this command, ensure the following requirements are met:

• A mount point to the relevant filesystem is set.

• Deploy at least one Data Services container before setting any quotas. If not running, quota operations defaults to single-process mode, potentially causing CLI to hang for extended periods. See Set up a Data Services container for background tasks.

Default quotas apply to newly created subdirectories, not the directory or existing children.

Use the following command to set a default quota of a directory:

weka fs quota set-default <path> [--soft soft] [--hard hard] [--grace grace] [--owner owner]

Parameters

Name	Value	Default
path*	Path to the directory to set the quota. The relevant filesystem must be mounted when setting the quota.	​
soft	Soft quota limit. Exceeding this number is displayed as an exceeded quota, but it is not enforced until the grace period is over. The capacity can be in decimal or binary units. Format: 1GB, 1TB, 1GiB, 1TiB, unlimited	unlimited
hard	Hard quota limit. Exceeding this number does not allow more writes before clearing some space in the directory. The capacity can be in decimal or binary units. Format: 1GB, 1TB, 1GiB, 1TiB, unlimited	unlimited
grace	Specify the grace period before the soft limit is treated as a hard limit. Format: 1d, 1w, unlimited	unlimited
owner	A unique string identifying the directory owner (can be a name, email, slack ID, etc.) This owner will be shown in the quota report and can be notified upon exceeding the quota. Supports up to 48 characters.

• To set advisory only quotas, use a soft quota limit without setting a grace period.

• When hard and soft quotas exist, setting the value of one of them to 0 clears this quota.

Set directory quota

Command: weka fs quota set

Before using the commands, verify that at least one Data Services container is set to enable the command to run the QUOTA_COLORING task in the background. For details, see Set up a Data Services container for background tasks.

Use the following command to set a directory quota:

weka fs quota set <path> [--soft soft] [--hard hard] [--grace grace] [--owner owner] [--file-system file-system] [--snap-name snap-name] [--color color]

Parameters

Name	Value	Default
path*	Path to the directory to set the quota. The relevant filesystem must be mounted when setting the quota.	​
soft	Soft quota limit. Exceeding this number is displayed as an exceeded quota, but it is not enforced until the grace period is over. The capacity can be in decimal or binary units. Format: 1GB, 1TB, 1GiB, 1TiB, unlimited	unlimited
hard	Hard quota limit. Exceeding this number does not allow more writes before clearing some space in the directory. The capacity can be in decimal or binary units. Format: 1GB, 1TB, 1GiB, 1TiB, unlimited	unlimited
grace	Specify the grace period before the soft limit is treated as a hard limit. Format: 1d, 1w, unlimited	unlimited
owner	A unique string identifying the directory owner (can be a name, email, slack ID, etc.) This owner will be shown in the quota report and can be notified upon exceeding the quota. Supports up to 48 characters.
file-system	Filesystem name. Use this parameter to set a quota outside the mount point.
snap-name	Name of the writable snapshot. Use this parameter to set a quota outside the mount point.

List directory quotas/default quotas

Command: weka fs quota list / weka fs quota list-default

Use the following command to list the directory quotas (by default, only exceeding quotas are listed) :

weka fs quota list [fs-name] [--snap-name snap-name] [--path path] [--under under] [--over over] [--quick] [--all]

Parameters

Name	Value	Default
fs-name*	Filesystem name. Use this parameter to display a quota report only on the specified filesystem.	All filesystems
snap-name	Displays the quota report from the time of the snapshot. It must be a valid snapshot name and be given along with the corresponding fs-name.
path	Path to a directory. Shows quota report only on the specified directory. The relevant filesystem must be mounted in the server running the query.
under	A path to a directory under a wekafs mount. The relevant filesystem must be mounted in the server running the query.
over	Shows only quotas over this percentage of usage. Possible values: 0-100
quick	Do not resolve inode to a path. Provides quicker results if the report contains many entries.	False
all	Shows all the quotas, not just the exceeding ones.	False

Use the following command to list the directory default quotas:

weka fs quota list-default [fs-name] [--snap-name snap-name] [--path path]

Parameters

Name	Value	Default
fs-name	Filesystem name. Use this parameter to display the default quotas only on the specified filesystem.	All filesystems
snap-name	Displays the default quotas from the time of the snapshot. It must be a valid snapshot name and be given along with the corresponding fs-name.
path	Path to a directory. Shows the default quotas report only on the specified directory. The relevant filesystem must be mounted in the server running the query.

Unset default quota

Command: weka fs quota unset-default

Use the following command to unset a default quota of a directory:

weka fs quota unset-default <path>

Parameters

Name	Value
path*	Path to the directory to set the quota. The relevant filesystem must be mounted when setting the quota.

Reset directory quota

Command: weka fs quota reset

Use the following command to reset a directory quota:

weka fs quota reset <path>

Parameters

Name	Value
path*	Path to the directory to unset the quota. The relevant filesystem must be mounted when setting the quota.