Give Feedback

reserved_ipv6_action

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

Synopsis

Assign or unassign a reserved IPv6 address to a Droplet. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPv6-Actions.

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.
`droplet_id` int		The unique identifier of the Droplet to assign or unassign. Required when type is `assign`.
`ip` str / required		The reserved IPv6 address.
`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`
`type` str / required	Choices: `assign` `unassign`	The type of action to perform.

Examples

- name: Assign reserved IPv6 to Droplet
  digitalocean.cloud.reserved_ipv6_action:
    token: "{{ token }}"
    ip: "2604:a880:800:10::1"
    type: assign
    droplet_id: 12345678

- name: Unassign reserved IPv6 from Droplet
  digitalocean.cloud.reserved_ipv6_action:
    token: "{{ token }}"
    ip: "2604:a880:800:10::1"
    type: unassign

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	Reserved IPv6 action information. Sample: `{ "completed_at": "2020-03-13T19:21:47.442049222Z", "id": 12345678, "resource_id": 12345678, "resource_type": "reserved_ipv6", "started_at": "2020-03-13T19:20:47.442049222Z", "status": "completed", "type": "assign" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Reserved IPv6 action result information. Sample: `[ "Assigned reserved IPv6 to Droplet", "Unassigned reserved IPv6 from Droplet" ]`

action
dict

always

Reserved IPv6 action information.
Sample:

{
  "completed_at": "2020-03-13T19:21:47.442049222Z",
  "id": 12345678,
  "resource_id": 12345678,
  "resource_type": "reserved_ipv6",
  "started_at": "2020-03-13T19:20:47.442049222Z",
  "status": "completed",
  "type": "assign"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str