doctl kubernetes cluster node-pool list
Generated on 10 Jun 2025
from doctl version
v1.130.0
Usage
doctl kubernetes cluster node-pool list <cluster-id|cluster-name> [flags]Aliases
lsDescription
Retrieves information about the specified cluster’s node pools, including:
- The node pool ID
- The slug indicating the machine size of the nodes, such as
s-1vcpu-2gb - The number of nodes in the pool
- The tags applied to the node pool
- The names of the nodes
Specifying --output=json when calling this command returns additional information about the individual nodes in the response, such as their IDs, status, creation time, and update time.
Example
The following example retrieves information about all node pools in a cluster named example-cluster and uses the --format flag to only return the ID, name, and nodes for each pool:
doctl kubernetes cluster node-pool list example-cluster --format ID,Name,NodesFlags
| Option | Description |
|---|---|
--format |
Columns for output in a comma-separated list. Possible values: ID, Name, Size, Count, Tags, Labels, Taints, Nodes. |
--help, -h |
Help for this command |
--no-header |
Return raw data with no headers Default: false |
Related Commands
| Command | Description |
|---|---|
| doctl kubernetes cluster node-pool | Display commands for managing node pools |
Global Flags
| Option | Description |
|---|---|
--access-token, -t |
API V2 access token |
--api-url, -u |
Override default API endpoint |
--config, -c |
Specify a custom config file Default: |
--context |
Specify a custom authentication context name |
--http-retry-max |
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5 |
--http-retry-wait-max |
Set the minimum number of seconds to wait before retrying a failed request
Default: 30 |
--http-retry-wait-min |
Set the maximum number of seconds to wait before retrying a failed request
Default: 1 |
--interactive |
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false |
--output, -o |
Desired output format [text|json] Default: text |
--trace |
Show a log of network activity while performing a command Default: false |
--verbose, -v |
Enable verbose output Default: false |