---
title: droplet_neighbors_info
description: List Droplet neighbors
product: Reference
url: https://docs.digitalocean.com/reference/ansible/reference/modules/droplet_neighbors_info/
last_updated: "2026-08-11"
---

> **For AI agents:** The documentation index is at [https://docs.digitalocean.com/llms.txt](https://docs.digitalocean.com/llms.txt). Markdown versions of pages use the same URL with `index.html.md` in place of the HTML page (for example, append `index.html.md` to the directory path instead of opening the HTML document).

# droplet_neighbors_info

## Synopsis

List all Droplets that are co-located on the same physical hardware. Droplet neighbors are Droplets that share the same physical server. This information can be useful for planning high-availability deployments. View the API documentation at [https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplets](https://docs.digitalocean.com/reference/api/api-reference/index.html.md#tag/Droplets).

## 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 a specific Droplet to get neighbors for. If not specified, returns all neighbor groupings for all Droplets.

`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

```yaml
- name: Get all Droplet neighbor groupings
  digitalocean.cloud.droplet_neighbors_info:
    token: "{{ token }}"

- name: Get neighbors for a specific Droplet
  digitalocean.cloud.droplet_neighbors_info:
    token: "{{ token }}"
    droplet_id: 12345678
```

## Return Values

KeyReturnedDescription

`droplets`, list when droplet_id is specified Full Droplet information when querying a specific Droplet's neighbors., Sample:,```json
[
  {
    "id": 87654321,
    "name": "neighbor-droplet",
    "region": {
      "slug": "nyc1"
    },
    "status": "active"
  }
]
```

`error`, dict failure DigitalOcean API error., Sample:,```json
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
```

`msg`, str always Droplet neighbors result information., Sample:,```json
[
  "Current Droplet neighbors",
  "No Droplet neighbors",
  "Neighbors for Droplet 12345678"
]
```

`neighbors`, list always Lists of Droplet IDs that are on the same physical hardware., Sample:,```json
[
  [
    12345678,
    87654321
  ],
  [
    11111111,
    22222222,
    33333333
  ]
]
```