mirror of
https://github.com/kemko/nomad.git
synced 2026-01-08 03:15:42 +03:00
dae496e427
* Enhance front matter description for search * acl section * alloc section * config section * deployment section * eval section * job section * license section * namespace section * node section * node pool section * operator section * plugin section * quota section * recommendation section * scaling section * sentinel section * server section * service section * setup section * system section * tls section * var section * volume section * change reference to command reference * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
79 lines
1.8 KiB
Plaintext
79 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad namespace status command reference'
|
|
description: >
|
|
The `nomad namespace status` command displays status information for the specified namespace.
|
|
---
|
|
|
|
# `nomad namespace status` command reference
|
|
|
|
The `namespace status` command is used to view the status of a particular
|
|
namespace.
|
|
|
|
<Tip>
|
|
Visit the <a href="https://developer.hashicorp.com/nomad/tutorials/manage-clusters/namespaces">
|
|
Nomad Namespaces tutorial
|
|
</a> for more information.
|
|
</Tip>
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad namespace status [options] <namespace_name>
|
|
```
|
|
|
|
If ACLs are enabled, this command requires a management ACL token or a token
|
|
that has a capability associated with the namespace.
|
|
|
|
## General options
|
|
|
|
@include 'general_options_no_namespace.mdx'
|
|
|
|
## Status options
|
|
|
|
- `-json` : Output the namespace status in its JSON format.
|
|
- `-t` : Format and display the namespace status using a Go template.
|
|
|
|
## Examples
|
|
|
|
View the status of a namespace:
|
|
|
|
```shell-session
|
|
$ nomad namespace status default
|
|
Name = api-prod
|
|
Description = Prod API servers
|
|
Quota = prod
|
|
EnabledDrivers = docker,exec
|
|
DisabledDrivers = raw_exec
|
|
EnabledNetworkModes = bridge,cni/custom
|
|
DisabledNetworkModes = host
|
|
|
|
Metadata
|
|
contact = platform-eng@example.com
|
|
|
|
Quota Limits
|
|
Region CPU Usage Memory Usage
|
|
global 500 / 2500 256 / 2000
|
|
```
|
|
|
|
The `-json` flag can be used to get the namespace status in json format:
|
|
|
|
```shell-session
|
|
$ nomad namespace status -json default
|
|
{
|
|
"Capabilities": null,
|
|
"CreateIndex": 1,
|
|
"Description": "Default shared namespace",
|
|
"Meta": null,
|
|
"ModifyIndex": 1,
|
|
"Name": "default",
|
|
"Quota": ""
|
|
}
|
|
|
|
Or use the `-t` flag to format and display the status using a Go template:
|
|
|
|
```shell-session
|
|
$ nomad namespace status -t {{.Description}} default
|
|
Default shared namespace
|
|
```
|