open-nomad/website/pages/docs/commands/quota/inspect.mdx

92 lines
2.4 KiB
Plaintext
Raw Normal View History

2017-10-13 21:02:30 +00:00
---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: quota inspect'
sidebar_title: inspect
2017-10-13 21:02:30 +00:00
description: >
The quota inspect command is used to view raw information about a particular
quota specification.
---
# Command: quota inspect
The `quota inspect` command is used to view raw information about a particular
quota.
2018-03-22 20:39:18 +00:00
~> Quota commands are new in Nomad 0.7 and are only available with Nomad
Enterprise.
2017-10-13 21:02:30 +00:00
## Usage
```plaintext
2017-10-13 21:02:30 +00:00
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.
2017-10-13 21:02:30 +00:00
## General Options
2020-02-06 23:45:31 +00:00
@include 'general_options.mdx'
2017-10-13 21:02:30 +00:00
## Inspect Options
- `-t` : Format and display the quota using a Go template.
2017-10-13 21:02:30 +00:00
## Examples
Inspect a quota specification:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad quota inspect default-quota
2017-10-13 21:02:30 +00:00
{
"Spec": {
"CreateIndex": 8,
"Description": "Limit the shared default namespace",
"Limits": [
{
"Hash": "NLOoV2WBU8ieJIrYXXx8NRb5C2xU61pVVWRDLEIMxlU=",
"Region": "global",
"RegionLimit": {
"CPU": 2500,
"DiskMB": 0,
"MemoryMB": 2000,
"Networks": null
}
}
],
"ModifyIndex": 56,
"Name": "default-quota"
},
"UsageLookupErrors": {},
"Usages": {
"global": {
"CreateIndex": 8,
"ModifyIndex": 56,
"Name": "default-quota",
"Used": {
"NLOoV2WBU8ieJIrYXXx8NRb5C2xU61pVVWRDLEIMxlU=": {
"Hash": "NLOoV2WBU8ieJIrYXXx8NRb5C2xU61pVVWRDLEIMxlU=",
"Region": "global",
"RegionLimit": {
"CPU": 500,
"DiskMB": 0,
"MemoryMB": 256,
"Networks": [
{
"CIDR": "",
"Device": "",
"DynamicPorts": null,
"IP": "",
"MBits": 0,
"Mode": "",
"ReservedPorts": null
}
]
2017-10-13 21:02:30 +00:00
}
}
}
}
}
}
```