77 lines
2 KiB
Plaintext
77 lines
2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'Commands: node pool nodes'
|
|
description: |
|
|
The node pool nodes command is used to list nodes in node pool.
|
|
---
|
|
|
|
# Command: node pool nodes
|
|
|
|
The `node pool nodes` command is used to list nodes in a node pool.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad node pool nodes [options] <node-pool>
|
|
```
|
|
|
|
If ACLs are enabled, this command requires a token with the `node:read`
|
|
capability and the `read` capability in a `node_pool` policy that matches the
|
|
node pool being targeted.
|
|
|
|
## General Options
|
|
|
|
@include 'general_options_no_namespace.mdx'
|
|
|
|
## Nodes Options
|
|
|
|
- `-filter`: Specifies an expression used to [filter results][api_filtering].
|
|
|
|
- `-json`: Output the nodes 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 nodes using a Go template.
|
|
|
|
- `-verbose`: Display full information.
|
|
|
|
## Examples
|
|
|
|
List nodes in the `prod` node pool:
|
|
|
|
```shell-session
|
|
$ nomad node pool nodes prod
|
|
ID DC Name Class Drain Eligibility Status
|
|
31c5347f dc2 client-3 <none> false eligible ready
|
|
3ed547cd dc1 client-1 <none> false eligible ready
|
|
6e98e378 dc2 client-2 <none> false eligible ready
|
|
```
|
|
|
|
Filter nodes with an expression:
|
|
|
|
```shell-session
|
|
$ nomad node pool nodes -filter='Datacenter == "dc2"' prod
|
|
ID DC Name Class Drain Eligibility Status
|
|
31c5347f dc2 client-3 <none> false eligible ready
|
|
6e98e378 dc2 client-2 <none> false eligible ready
|
|
```
|
|
|
|
Paginate list:
|
|
|
|
```shell-session
|
|
$ nomad node pool nodes -per-page=2 prod
|
|
ID DC Name Class Drain Eligibility Status
|
|
31c5347f dc2 us-client-3 <none> false eligible ready
|
|
3ed547cd dc1 us-client-1 <none> false eligible ready
|
|
|
|
Results have been paginated. To get the next page run:
|
|
|
|
nomad node pool nodes -per-page=2 prod -page-token 6e98e378-b41a-86ac-8e5e-5ca8ab66236d
|
|
```
|
|
|
|
[api_filtering]: /nomad/api-docs#filtering
|
|
[api_pagination]: /nomad/api-docs#pagination
|