mirror of
https://github.com/kemko/nomad.git
synced 2026-01-05 09:55:44 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
133 lines
3.3 KiB
Plaintext
133 lines
3.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad node pool list command reference'
|
|
description: |
|
|
The `nomad node pool list` command displays all node pools or those matching a filter expression.
|
|
---
|
|
|
|
# `nomad node pool list` command reference
|
|
|
|
The `node pool list` command is used to list existing node pools.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad node pool list [options]
|
|
```
|
|
|
|
If ACLs are enabled, this command requires a management token to view all node
|
|
pools. A non-management token can be used to list node pools for which the
|
|
token has the 'read' capability.
|
|
|
|
## Options
|
|
|
|
- `-filter`: Specifies an expression used to [filter results][api_filtering].
|
|
|
|
- `-json`: Output the node pools in JSON format.
|
|
|
|
- `-page-token`: Where to start [pagination][api_pagination].
|
|
|
|
- `-per-page`: How many results to show per page. If not specified, or set to
|
|
`0`, all results are returned.
|
|
|
|
- `-t`: Format and display node pools using a Go template.
|
|
|
|
## Examples
|
|
|
|
List all node pools:
|
|
|
|
```shell-session
|
|
$ nomad node pool list
|
|
Name Description
|
|
all Node pool with all nodes in the cluster.
|
|
default Default node pool.
|
|
dev Node pool for dev workloads.
|
|
prod Node pool for production workloads.
|
|
```
|
|
|
|
Retrieve information in JSON format:
|
|
|
|
```shell-session
|
|
$ nomad node pool list -json
|
|
[
|
|
{
|
|
"CreateIndex": 1,
|
|
"Description": "Node pool with all nodes in the cluster.",
|
|
"Meta": null,
|
|
"ModifyIndex": 1,
|
|
"Name": "all",
|
|
"SchedulerConfiguration": null
|
|
},
|
|
{
|
|
"CreateIndex": 1,
|
|
"Description": "Default node pool.",
|
|
"Meta": null,
|
|
"ModifyIndex": 1,
|
|
"Name": "default",
|
|
"SchedulerConfiguration": null
|
|
},
|
|
{
|
|
"CreateIndex": 21,
|
|
"Description": "Node pool for dev workloads.",
|
|
"Meta": {
|
|
"env": "development"
|
|
},
|
|
"ModifyIndex": 21,
|
|
"Name": "dev",
|
|
"SchedulerConfiguration": null
|
|
},
|
|
{
|
|
"CreateIndex": 39,
|
|
"Description": "Node pool for production workloads.",
|
|
"Meta": {
|
|
"env": "production"
|
|
},
|
|
"ModifyIndex": 39,
|
|
"Name": "prod",
|
|
"SchedulerConfiguration": {
|
|
"SchedulerAlgorithm": "spread"
|
|
}
|
|
}
|
|
]
|
|
```
|
|
|
|
Customize output with a Go template:
|
|
|
|
```shell-session
|
|
$ nomad node pool list -t '{{range .}}{{.Name}} [{{.Meta.env}}] - {{.Description}}{{println}}{{end}}'
|
|
all [<no value>] - Node pool with all nodes in the cluster.
|
|
default [<no value>] - Default node pool.
|
|
dev [development] - Node pool for dev workloads.
|
|
prod [production] - Node pool for production workloads.
|
|
```
|
|
|
|
```shell-session
|
|
$ nomad node pool info -t "{{.Name}} [{{.Meta.env}}] - {{.Description}}" prod
|
|
prod [production] - Node pool for production workloads.
|
|
```
|
|
|
|
Paginate list:
|
|
|
|
```shell-session
|
|
$ nomad node pool list -per-page 2
|
|
Name Description
|
|
all Node pool with all nodes in the cluster.
|
|
default Default node pool.
|
|
|
|
Results have been paginated. To get the next page run:
|
|
|
|
nomad node pool list -per-page 2 -page-token dev
|
|
|
|
$ nomad node pool list -per-page 2 -page-token dev
|
|
Name Description
|
|
dev Node pool for dev workloads.
|
|
prod Node pool for production workloads.
|
|
```
|
|
|
|
## General options
|
|
|
|
@include 'general_options_no_namespace.mdx'
|
|
|
|
[api_filtering]: /nomad/api-docs#filtering
|
|
[api_pagination]: /nomad/api-docs#pagination
|