Give Feedback

floating_ip

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

Synopsis

Create or delete floating IPs. NOTE: Floating IPs have been renamed to Reserved IPs. This module is provided for backwards compatibility. New implementations should use the reserved_ip module instead. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IPs.

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 ID of the Droplet that the floating IP will be assigned to.
`ip` str		The floating IP address. Used for lookup when deleting.
`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.
`region` str		The slug identifier for the region where the floating IP will be reserved. Required when creating a floating IP without a droplet_id.
`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: Create floating IP in region
  digitalocean.cloud.floating_ip:
    token: "{{ token }}"
    state: present
    region: nyc1

- name: Create floating IP and assign to Droplet
  digitalocean.cloud.floating_ip:
    token: "{{ token }}"
    state: present
    droplet_id: 12345678

- name: Delete floating IP
  digitalocean.cloud.floating_ip:
    token: "{{ token }}"
    state: absent
    ip: 192.0.2.1

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`floating_ip` dict	always	Floating IP information. Sample: `{ "droplet": { "id": 12345678, "name": "my-droplet" }, "ip": "192.0.2.1", "region": { "name": "New York 1", "slug": "nyc1" } }`
`msg` str	always	Floating IP result information. Sample: `[ "Created floating IP 192.0.2.1", "Deleted floating IP 192.0.2.1", "Floating IP would be created", "Floating IP 192.0.2.1 does not exist" ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

floating_ip
dict

always

Floating IP information.
Sample:

{
  "droplet": {
    "id": 12345678,
    "name": "my-droplet"
  },
  "ip": "192.0.2.1",
  "region": {
    "name": "New York 1",
    "slug": "nyc1"
  }
}

msg
str