Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Managing Quota Groups

Prev Next

Viewing Quota Groups

Viewing Quota Groups in VAST Web UI

  • From the left navigation menu, select Element Store and then Quota Groups to open the Quota Groups page.

    The following information can be displayed for each quota group:

    Tip

    To display or hide fields, click column_menu.png to the right of a column title, and then click columns.png to open a dropdown where you can select or unselect fields.

    ID

    The ID of the quota group.

    Name

    The name of the quota group.

    Quotas

    The count of quotas in the quota group.

    Type

    The type of the quota group: View or User.

    Note

    With VAST Cluster 5.5.0, user quotas are not supported.

    State

    The status of the quota group:

    • OK. The quota group was created. No limits have been exceeded.

    • Failed. Quota group creation failed.

    • Soft limit (capacity) exceeded. The aggregated size of the member quota directories has exceeded the soft limit set in the quota group.

    • Soft limit (files and directories) exceeded. The combined number of files and directories (or objects) in member quota directories has exceeded the soft limit set in the quota group.

    • Soft Limits both exceeded. Both the aggregated size of member quota directories and the combined number of files and directories (or objects) in the member quota directories have exceeded the respective soft limits set in the quota group.

    • Hard limit (capacity) exceeded. The aggregated size of the member quota directories has exceeded the hard limit set in the quota group.

    • Hard limit (files and directories)exceeded. The combined number of files and directories (or objects) in member quota directories has exceeded the hard limit set in the quota group.

    • Hard Limits both exceeded. Both the aggregated size of member quota directories and the combined number of files and directories (or objects) in the member quota directories have exceeded the respective hard limits set in the quota group.

    • Grace Period expired. A quota group's soft limit was exceeded for the whole duration of the grace period set in the quota group.

    Capacity Percentage

    The percentage of quota group capacity in use relative to the quota group limits.

    Hovering over a percentage displays a popup with precise used capacity values (e.g. in TB) and the soft and hard limits in effect.

    File & Directories Percentage

    The percentage of the number of files and directories (or objects) inside the directories controlled by the quota group, relative to the quota group limits.

    Hovering over a percentage displays a popup with precise counts of file and directories (or objects) and the soft and hard limits in effect.

    Capacity

    The amount of quota group capacity in use.

    Tenant

    Shows the tenant associated with the quota group.

Viewing Quota Groups in VAST CLI

To list all quota groups, use the quotagroup list command.

To view details of a quota group, use the quotagroup show command.

Creating a Quota Group

Creating a Quota Group in VAST Web UI

  1. From the left navigation menu, select Element Store and then Quota Groups.

  2. Click Create Quota Groups to open the Add Quota Group dialog.

  3. In the General Configuration tab, complete the fields:

    1. Complete the fields:

      Group Name (required)

      A unique name for the quota group.

      Tenant (required)

      Select a tenant for the quota group.

      Note

      This field is displayed only when there are multiple tenants configured on the cluster.

    2. Use the Available Quotas and Attached Quotas field to add quotas to the group. Both lists are filtered according to the quota type(s) you selected for the quota group in the previous step.

  4. In the Group Rules tab:

    1. To set a soft limit for the quota group, select Add soft limit and complete the fields:

      Capacity

      Storage space usage limit above which warnings of exceeding the quota are issued, and the grace period countdown is triggered.

      Files & Directories

      Number of directories and unique files under the path above which warnings of exceeding the quota are issued, and the grace period countdown commences. A file with multiple hard links is counted only once.

      Grace period

      Set this value to trigger an alarm and block write operations to the directory if either of the soft limits on the directory are exceeded for a specified time period. 

      If the grace period is not set, the directory is only write blocked if and when usage reaches one of the hard limits. 

      Specify the grace period in the format: [DD] [HH:[MM:]]ss. Examples:

      • To specify 30 days, 20 hours, 15 minutes and 10 seconds, enter 30 20:15:10.

      • To specify 18 minutes, enter 18:00.

      • To specify 20 hours, enter 20:00:00.

      • You can also specify time in days, hours, minutes or seconds, in the format, for example 10d, 10h, 10m or 10s. The usage is case sensitive, entering 10D or 10H will return an error.

    2. To set a hard limit for the quota group, select Add hard limit and complete the fields:

      Capacity

      Storage usage limit, above which no further writes are allowed.

      When the hard limit is reached, the HARD_EXCEEDED alarm is triggered.

      The value must be a complete integer and must be specified with a unit of measurement. Do not insert a space between the value and the unit of measurements. Valid units are:

      • Base 10: KB, MB, GB, TB, PB, EB,

      • Base 2: KiB, MiB, GiB, TiB, PiB, EiB

      The units are case-insensitive. For example: 4gb is valid. 

      Files & Directories

      Number of directories and unique files under the path, above which no writes are allowed.

      Note

      A file with multiple hard links is counted only once.

    3. Toggle Get alarms on or off to enable or disable raising of VMS alarms when users or groups reach their limits. By default, this option is enabled. For more information, see Enabling or Disabling Quota Alarms.

      This setting does not affect notification emails sent to users when they exceed quota limits. Notification emails continue to be sent when this setting is disabled.

    4. Toggle Get emails from Active Directory/LDAP on or off to allow or prohibit querying of providers for email addresses used to send email notifications when a limit is exceeded. By default, this option is enabled.

  5. Skip the Accounting tab. This tab is intended for tracking quota consumption and does not provide any settings necessary for quota creation.

  6. Click Create

    Quota group creation begins. The process is asynchronous and you can track the quota state in the Quota Groups page.

Creating a Quota Group in VAST CLI

To create a quota group, use the quotagroup create command.

To add quotas to a quota group, use the quotagroup assign-quotas command.

Modifying a Quota Group

When modifying a quota group, you can view accounting for member quotas and use it to help you decide what quota group rules to set.

Modifying a Quota Group in VAST Web UI

  1. From the left navigation menu, select Element Store and then Quota Groups.

  2. In the Quota Groups page, right-click the quota group you want to change, and select Edit.

  3. In the Update Quota Group dialog that opens, make changes you want. For an explanation of each setting, see Creating a Quota Group.

  4. In the Accounting tab, a list of all member quotas is displayed with details for each of them.

    To filter the list, enter a text string into the Search field. The list is filtered responsively as you type. (Do not press Enter when searching because that will save your quota group changes immediately.)

    For an explanation of each field that can be displayed for a quota, see Viewing Quotas.

  5. When you are done making changes to the quota, click Update.

    The quota is updated.

Modifying a Quota Group in VAST CLI

To modify a quota group, run the quotagroup modify command.

Viewing Quota Group Consumption

Viewing Quota Group Consumption in VAST Web UI

  1. From the left navigation menu, select Element Store and then Quota Groups to open the Quota Groups page.

  2. Right-click a quota group for which you want to view consumption details and select View.

  3. In the dialog that opens, go to the Accounting tab.

    The tab lists quotas included in the quota group. For an explanation of each field displayed for a quota, see Viewing Quotas.

Viewing Quota Group Consumption in VAST CLI

To view consumption details for a quota group, use the quotagroup show command.

Deleting a Quota Group

Deleting a Quota Group in VAST Web UI

  1. From the left navigation menu, select Element Store and then Quota Groups.

  2. In the Quota Groups page that opens, right-click the quota group you want to delete and select Remove.

  3. Click Yes to confirm the deletion.

Deleting a Quota Group in VAST CLI

To delete a quota group, run the quotagroup delete command.