Command: quota status

The quota status command is used to view the status of a particular quota specification.

Quota commands are only available with Nomad Enterprise.

Usage

nomad quota status [options] <quota_name>

If ACLs are enabled, this command requires a token with the quota:read capability and access to any namespaces that the quota is applied to.

General Options

-address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.
-region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.
-namespace=<namespace>: The target namespace for queries and actions bound to a namespace. Overrides the NOMAD_NAMESPACE environment variable if set. If set to '*', subcommands which support this functionality query all namespaces authorized to user. Defaults to the "default" namespace.
-no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.
-force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.
-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.
-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.
-client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.
-client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.
-tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.
-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

Inspect Options

-json: Output the quota specifications in a JSON format.
-t: Format and display the quota using a Go template.

Examples

View the status of a quota specification:

$ nomad quota status default-quotaName        = default-quotaDescription = Limit the shared default namespaceLimits      = 1 Quota LimitsRegion  CPU Usage  Core Usage  Memory Usage  Memory Max Usage  Variables Usageglobal  0 / 1000   0 / 1       0 / 1000      0 / inf           0 / inf

The -json flag can be used to get the quota status in json format:

$ nomad quota status -json default-quota{    "CreateIndex": 8,    "Description": "Limit the shared default namespace",    "Limits": [        {            "Hash": "p7s7A+4mFt+M41NS3nB3APheQS9YaePLguvnNn/c1t4=",            "Region": "global",            "RegionLimit": {                "CPU": 1000,                "Cores": 1,                "Devices": null,                "DiskMB": 0,                "IOPS": 0,                "MemoryMB": 1000,                "MemoryMaxMB": 0,                "NUMA": null,                "Networks": null            },            "VariablesLimit": 0        }    ],    "ModifyIndex": 56,    "Name": "default-quota"}

Or use the -t flag to format and display the quota status using a Go template:

$ nomad quota status -t {{ .Description }} default-quotaLimit the shared default namespace