Command: node pool list

The node pool list command is used to list existing node pools.

Usage

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.

General Options

• -address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

• -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.

• -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.

• -force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.

• -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.

• -ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.

• -client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.

• -client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.

• -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.

• -tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.

• -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

List Options

• -filter: Specifies an expression used to filter results.

• -json: Output the node pools in JSON format.

• -page-token: Where to start 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:

$ 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:

$ 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:

$ 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.

$ nomad node pool info -t "{{.Name}} [{{.Meta.env}}] - {{.Description}}" prod
prod [production] - Node pool for production workloads.

Paginate list:

$ 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.