open-nomad/website/content/docs/commands/namespace/list.mdx

50 lines
1.1 KiB
Plaintext
Raw Normal View History

2017-09-19 14:47:10 +00:00
---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: namespace list'
description: |
2017-09-19 14:47:10 +00:00
The namespace list command is used to list namespaces.
---
# Command: namespace list
The `namespace list` command is used list available namespaces.
2020-10-22 21:59:40 +00:00
~> Namespaces are open source in Nomad 1.0. Namespaces were Enterprise-only
2020-12-07 22:04:11 +00:00
when introduced in Nomad 0.7.
2017-09-19 14:47:10 +00:00
## Usage
```plaintext
2017-09-19 14:47:10 +00:00
nomad namespace list [options]
```
The `namespace list` command requires no arguments.
If ACLs are enabled, this command requires a management ACL token to view all
namespaces. A non-management token can be used to list namespaces for which it
has an associated capability.
2017-09-19 14:47:10 +00:00
## General Options
@include 'general_options_no_namespace.mdx'
2017-09-19 14:47:10 +00:00
## List Options
- `-json` : Output the namespaces in their JSON format.
2017-09-19 14:47:10 +00:00
- `-t` : Format and display the namespaces using a Go template.
2017-09-19 14:47:10 +00:00
## Examples
List all namespaces:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad namespace list
2017-09-19 14:47:10 +00:00
Name Description
default Default shared namespace
api-prod Production instances of backend API servers
api-qa QA instances of backend API servers
web-prod Production instances of webservers
web-qa QA instances of webservers
```