Give Feedback

floating_ip_action

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

Synopsis

Assign or unassign a floating IP to a Droplet. NOTE: Floating IPs have been renamed to Reserved IPs. This module is provided for backwards compatibility. New implementations should use the reserved_ip_assign module instead. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IP-Actions.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`action` str / required	Choices: `assign` `unassign`	The action to perform on the floating IP.
`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 ID of the Droplet to assign the floating IP to. Required when action is assign.
`ip` str / required		The floating IP 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`

Examples

- name: Assign a floating IP to a Droplet
  digitalocean.cloud.floating_ip_action:
    token: "{{ token }}"
    ip: 192.0.2.1
    action: assign
    droplet_id: 12345678

- name: Unassign a floating IP from a Droplet
  digitalocean.cloud.floating_ip_action:
    token: "{{ token }}"
    ip: 192.0.2.1
    action: unassign

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	DigitalOcean action information. Sample: `{ "completed_at": "2023-09-03T12:59:15Z", "id": 1882339039, "region": { "name": "New York 3", "slug": "nyc3" }, "resource_id": "192.0.2.1", "resource_type": "floating_ip", "started_at": "2023-09-03T12:59:10Z", "status": "completed", "type": "assign" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Floating IP action result information. Sample: `[ "Floating IP 192.0.2.1 assigned to Droplet 12345678", "Floating IP 192.0.2.1 unassigned", "Floating IP action would be performed" ]`

action
dict

always

DigitalOcean action information.
Sample:

{
  "completed_at": "2023-09-03T12:59:15Z",
  "id": 1882339039,
  "region": {
    "name": "New York 3",
    "slug": "nyc3"
  },
  "resource_id": "192.0.2.1",
  "resource_type": "floating_ip",
  "started_at": "2023-09-03T12:59:10Z",
  "status": "completed",
  "type": "assign"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str