mirror of
https://github.com/kemko/nomad.git
synced 2026-01-07 02:45: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>
72 lines
1.5 KiB
Plaintext
72 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'nomad node pool info command reference'
|
|
description: |
|
|
The `nomad node pool info` command displays information about a node pool.
|
|
---
|
|
|
|
# `nomad node pool info` command reference
|
|
|
|
The `node pool info` command is used to fetch information about an existing
|
|
node pool.
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad node pool info [options] <node-pool>
|
|
```
|
|
|
|
If ACLs are enabled, this command requires a token with the `read` capability
|
|
in a `node_pool` policy that matches the node pool being targeted.
|
|
|
|
## General options
|
|
|
|
@include 'general_options_no_namespace.mdx'
|
|
|
|
## Info options
|
|
|
|
- `-json`: Output the node pool in its JSON format.
|
|
|
|
- `-t`: Format and display node pool using a Go template.
|
|
|
|
## Examples
|
|
|
|
Retrieve information on a node pool:
|
|
|
|
```shell-session
|
|
$ nomad node pool info prod
|
|
Name = prod
|
|
Description = Node pool for production workloads.
|
|
|
|
Metadata
|
|
env = production
|
|
|
|
Scheduler Configuration
|
|
Scheduler Algorithm = spread
|
|
```
|
|
|
|
Retrieve information in JSON format:
|
|
|
|
```shell-session
|
|
$ nomad node pool info -json prod
|
|
{
|
|
"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 info -t "{{.Name}} [{{.Meta.env}}] - {{.Description}}" prod
|
|
prod [production] - Node pool for production workloads.
|
|
```
|