Give Feedback

reserved_ipv6s_info

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

Synopsis

List all reserved IPv6 addresses on your account. Reserved IPv6 addresses are static addresses that can be assigned to Droplets and retained across Droplet deletion and recreation. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPv6.

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.
`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 reserved IPv6 addresses
  digitalocean.cloud.reserved_ipv6s_info:
    token: "{{ token }}"

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	Reserved IPv6 addresses result information. Sample: `[ "Current reserved IPv6 addresses", "No reserved IPv6 addresses" ]`
`reserved_ipv6s` list	always	Reserved IPv6 addresses. Sample: `[ { "droplet": { "id": 12345678, "name": "my-droplet" }, "ip": "2604:a880:800:10::1", "region_slug": "nyc1", "reserved_at": "2020-03-13T19:20:47.442049222Z" } ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Reserved IPv6 addresses result information.
Sample:

[
  "Current reserved IPv6 addresses",
  "No reserved IPv6 addresses"
]

reserved_ipv6s
list