Give Feedback

kubernetes_node_pools_info

Generated on 13 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

List all node pools in a Kubernetes cluster. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Kubernetes.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`cluster_id` str / required		The UUID of the Kubernetes cluster.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Get Kubernetes node pools
  digitalocean.cloud.kubernetes_node_pools_info:
    token: "{{ token }}"
    cluster_id: bd5f5959-5e1e-4205-a714-a914373942af

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Node pools result information. Sample: `[ "Current node pools", "No node pools" ]`
`node_pools` list	always	Node pools. Sample: `[ { "count": 3, "id": "cdda885e-7663-40c8-bc74-3a036c66545d", "name": "worker-pool", "nodes": [ { "id": "123abc", "name": "worker-pool-abc123", "status": { "state": "running" } } ], "size": "s-2vcpu-4gb", "tags": [ "production" ] } ]`

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str

always

Node pools result information.
Sample:

[
  "Current node pools",
  "No node pools"
]

node_pools
list