Files
nomad/website/content/docs/commands/quota/inspect.mdx
Aimee Ukasick 23fd87d9c9 Docs: Commands section move "General options" to page bottom (#26001)
* sectionless files plus acl section

* alloc section

* config, deployment sections

* job section

* licence, namespace

* node, node-pool

* operator

* plugin, quota, recommendation

* scaling, sentinel, server, service, system, var, volume

* Add "ENT" label to left nav for enterprise commands

* job tag break into separate folder and files; update options header
2025-06-12 14:31:38 -05:00

129 lines
3.4 KiB
Plaintext

---
layout: docs
page_title: 'nomad quota inspect command reference'
description: >
The `nomad quota inspect` command displays raw information about a particular
quota specification in Nomad Enterprise.
---
# `nomad quota inspect` command reference
The `quota inspect` command is used to view raw information about a particular
quota. The default output is in JSON format.
<EnterpriseAlert product="nomad"/>
## Usage
```plaintext
nomad quota inspect [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.
## Options
- `-json`: Output the quota specifications in a JSON format.
- `-t`: Format and display the quota using a Go template.
## Examples
Inspect a quota specification:
```shell-session
$ nomad quota inspect default-quota
{
"Spec": {
"CreateIndex": 11,
"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": 11,
"Name": "default-quota"
},
"UsageLookupErrors": {},
"Usages": {
"global": {
"CreateIndex": 11,
"ModifyIndex": 12,
"Name": "default",
"Used": {
"p7s7A+4mFt+M41NS3nB3APheQS9YaePLguvnNn/c1t4=": {
"Hash": "p7s7A+4mFt+M41NS3nB3APheQS9YaePLguvnNn/c1t4=",
"Region": "global",
"RegionLimit": {
"CPU": 0,
"Cores": 0,
"Devices": null,
"DiskMB": 0,
"IOPS": 0,
"MemoryMB": 0,
"MemoryMaxMB": 0,
"NUMA": null,
"Networks": null
},
"VariablesLimit": 0
}
}
}
}
}
```
The `-json` flag can be used to get the quota specs in json format:
```shell-session
$ nomad quota inspect -json default-quota
{
"CreateIndex": 11,
"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": 11,
"Name": "default-quota"
}
```
Or use the `-t` flag to format and display the quota specs using a Go template:
```shell-session
$ nomad quota inspect -t '{{ .Description }}' default-quota
Limit the shared default namespace
```
## General options
@include 'general_options.mdx'