Previous Topic: Log ManagementNext Topic: Server Management


Quota Management

This section describes commands that display and manage quotas for individual users and groups.

This section contains the following topics:

quota config

quota info

quota list

quota modify

quota put

quota config

Get or set default warn and burst levels for grid quotas.

Syntax:

quota config [warn=<val>] [burst=<val>] [--batch] [--force]

Options:

warn=<val>

Set warn (in percent) value for the grid's quotas. Allowed values are integers between 0 and 99, 0 means no warnings.

burst=<val>

Set burst (in percent) value for the grid's quotas. Allowed values are any integers equal or greater than 0, 0 means no burst allowed.

--batch

Display output in UDL format.

--force

Don't prompt for user confirmation if the change will result in a quota limit being exceeded.

Examples:
quota config

Display current warn and burst configuration values.

quota config warn=75

Set warn value for the grid's quotas

Notes:

The values apply to all quotas that don't have explicit warn or burst set. When neither warn or burst is specified, the current values are displayed. Only grid administrators can set the values, regular users can only get the current value. The values can be specified as an integer with or without a percent sign (%).

Non-batch output

Warn   : <val>%
Burst  : <val>%

Batch output

quota_config
   {
   warn  = <val>
   burst = <val>
   }
quota info

Display information for a quota entry.

Syntax:

quota info <principal> [--verbose] [--batch]

Options:

<principal>

User/group for which to display quota information. <principal> is in the form:

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user' and <name> is the group or user name.

@<ID>

ID of the user or group. For example, '@67fb02d7-eaf4-4943-aaf8-37bad5d26f0c'

--verbose

Display current resource usage and available quota information.

--batch

Display output in UDL format.

Examples:
quota info user1

Display quota information for user1.

Notes:

If no principal is specified, quota info is equivalent to quota info <current_user>.

Non-batch output

Description  : <val>
Parent       : <val>
Tags         : <val>
Exceeded     : yes|no|warn (only if --verbose is specified)
Warn         : <val>%
Burst        : <val>%
F    Resource   Assigned     Allowed       Used         Available
---------------------------------------------------------------
<F>  CPU        <val>        <val>         <val>        <val>
<F>  MEM        <val> <unit> <val> <unit>  <val> <unit> <val> <unit>
<F>  BW         <val> <unit> <val> <unit>  <val> <unit> <val> <unit>
<F>  DISK       <val> <unit> <val> <unit>  <val> <unit> <val> <unit>

F - Flags:
^ - quota warn level reached
! - quota limit reached

Note: The Used and Available columns appear only when --verbose is specified. The flags column appears only if at least one flag is present.

Batch output

quota
   {
   principal           : scope=<val>, type=<val>, name=<val>
   Description         = <val>
   parent              : scope=<val>, type=<val>, name=<val>
   tags                = <val>
   warn                = <val>
   burst               = <val>
   exceeded            : warn=<val>, limit=<val>  (only if --verbose)

   resources assigned  : cpu=<val>, mem=<val>, bw=<val>, disk=<val>
   resources allowed   : cpu=<val>, mem=<val>, bw=<val>, disk=<val>
   resources used      : cpu=<val>, mem=<val>, bw=<val>, disk=<val> (only if --verbose)
   resources available : cpu=<val>, mem=<val>, bw=<val>, disk=<val> (only if --verbose)
   }
quota list

List quota entries for a principal or the grid in a tree-like view.

Syntax:

quota list [<principal>] [--verbose] [--batch]

Options:

<principal>

User/group for which to list quota entries. <principal> is in the form:

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user' and <name> is the group or user name.

@<ID>

ID of the user or group. For example, '@67fb02d7-eaf4-4943-aaf8-37bad5d26f0c'

--verbose

Include entries with no resource limits or parent and include Resource usage in the output.

--batch

Display output in UDL format.

Example:
quota list

Display quota entries for the grid.

Notes:

By default, all users with resource limits are displayed.

Non-batch output

If --verbose is not specified , the output is a table with the following headings:

F

Quota entry flags

Principal

Principal name

Warn/Burst

Warn and Burst values

CPU

CPU Limit

MEM

Memory Limit

BW

Bandwidth Limit

DISK

Disk Limit

Description

quota description

If--verbose is specified, the output is a table with the following headings:

F

Quota entry flags

Principal

Principal name

Warn/Burst

Warn and Burst values

CPU Limit/Used

CPU Limit and CPU used

MEM Limit/Used

Memory limit and memory used

BW Limit/Used

Bandwidth limit and bandwidth used

DISK Limit/Used

Disk limit and disk used

Description

quota description

The flags and description columns are displayed only if at least one is present.

Batch output

The following values are only displayed if --verbose:

quota: no_owner=<val>, cpu_used=<val>, mem_used=<val>, disk_used=<val> ,quota: principal=<val>, type=<val>, scope=<val>, cpu_assigned=<val>, cpu_allowed=<val>, cpu_used=<val>, cpu_available=<val>, mem_assigned=<val>, mem_allowed=<val>, mem_used=<val>, mem_available=<val>, bw_allowed=<val>, bw_used=<val>, bw_avialble=-<val>, disk_assigned=<val>, disk_allowed=<val>, disk_used=<val>, disk_available=<val>, description=<val>, tags=<val>, warn=<val>, burst=<val>, exceeded_warn=<val>, exceeded_limit=<val>

quota modify

Modify a quota entry for a principal.

Syntax:

quota modify <principal> [description=<description>] [tags=<tags>] 
             [cpu=<val>] [mem=<val>] [bw=<val>] [disk=<val>]
             [parent=<principal>] [warn=<val>] [burst=<val>] [--force]

Options:

<principal>

User/group for which to modify quota. <principal> is in the form:

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user' and <name> is the group or user name.

@<ID>

ID of the user or group. For example, '@67fb02d7-eaf4-4943-aaf8-37bad5d26f0c'

<description>

Specify quota description.

<tags>

Specify a comma-separated list of quota tags (may be used for billing purposes)

cpu=<val>
mem=<val>
bw=<val>
disk=<val>

Resource limits. Zero or one of these can be specified. If a 0 is specified, the resource is unavailable for the principal. If an empty value is specified, then there is no limit on the resource use. If no unit is specified for mem, bw, or disk, the value is interpreted as MB or Mbps in the case of bw.

<parent>

Specify a parent quota. The principal must be an existing group. A maximum level of 8 nested quotas is allowed, circular references are not allowed. If an empty value is given, no parent quota is set. This can only be set for groups; users have their parent quota set to their primary group.

warn=<val>

Specify warn (in percent) value for the quota. Allowed values are integers between 0 and 99, 0 means no warnings. An empty value means no warn level will be specified for this principal, in which case the default grid configuration will be applied (as set by quota config).

burst=<value>

Specify burst (in percent) value for the quota. Allowed values are any integers equal or greater than 0, 0 means no burst allowed. Empty value means no burst level will be specified for this principal, in which case the default grid configuration will be applied (as set by quota config)

--force

Do not prompt for user confirmation if the change will result in a quota limit being exceeded.

Example
quota modify myuser cpu=10  

Modify the quota entry for user 'myuser' assigning the user's CPU quota to 10 CPUs

Note

Only values that are specified as part of the command are modified. If the changes result in quota entry for which a resource limit is exceeded, a warning is printed and the user is prompted for confirmation (unless --force is used).

quota put

Replace a quota entry for a principal.

Syntax
quota put <principal> [description=<description>] [tags=<tags>] 
             [cpu=<val>] [mem=<val>] [bw=<val>] [disk=<val>] 
             [parent=<principal>] [warn=<val>] [burst=<val>] [--force]
Options
<principal>

User/group for which to replace quota. <principal> is in the form

<name>

Local user or group.

/<name>

Global user or group.

<scope>:<type>:<name>

A fully qualified principal name where <scope> is 'global' or 'local', <type> is 'group' or 'user' and <name> is the group or user name.

@<ID>

ID of the user or group. For example, '@67fb02d7-eaf4-4943-aaf8-37bad5d26f0c'

<description>

Specify quota description.

<tags>

Specify a comma-separated list of quota tags (may be used for billing purposes).

cpu=<val>
mem=<val>
bw=<val>
disk=<val>

Resource limits. Zero or one of these can be specified. If a 0 is specified, the resource is unavailable for the principal. If an empty value is specified, then there is no limit on the resource use. If no unit is specified for mem, bw, or disk, the value is interpreted as MB or Mbps in the case of bw.

<parent>

Specify a parent quota. The principal must be an existing group. A maximum level of 8 nested quotas is allowed, circular references are not allowed. If an empty value is given, no parent quota is set. This can only be set for groups; users have their parent quota set to their primary group.

warn=<val>

Specify warn (in percent) value for the quota. Allowed values are integers between 0 and 99, 0 means no warnings. An empty value means no warn level will be specified for this principal, in which case the default grid configuration will be applied (as set by quota config).

burst=<value>

Specify burst (in percent) value for the quota. Allowed values are any integers equal or greater than 0, 0 means no burst allowed. Empty value means no burst level will be specified for this principal, in which case the default grid configuration will be applied (as set by quota config).

--force

Do not prompt for user confirmation if the change will result in a quota limit being exceeded.

Example
quota put myuser description="Sample User" cpu=10 mem=10G bw=10G disk=20G warn=75 burst=75 parent="Sample_Group"

Replace the quota entry for user 'myuser'

Note

Only values that are specified as part of the command are set, all other values are left blank. If the changes result in quota entry for which a resource limit is exceeded, a warning is printed and the user is prompted for confirmation (unless --force is used).