Give Feedback

nfs_info

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

Synopsis

List all NFS file shares on your account. NFS (Network File System) provides shared file storage that can be mounted by multiple Droplets simultaneously. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/NFS.

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.
`region` str / required		The slug identifier for the region to list NFS shares from.
`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 NFS shares in nyc3
  digitalocean.cloud.nfs_info:
    token: "{{ token }}"
    region: nyc3

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	NFS shares result information. Sample: `[ "Current NFS shares", "No NFS shares" ]`
`shares` list	always	NFS file shares. Sample: `[ { "created_at": "2020-03-13T19:20:47.442049222Z", "host": "10.132.0.2", "id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "mount_path": "/mnt/nfs-share", "name": "my-nfs-share", "region": "nyc3", "size_gib": 100, "status": "ACTIVE", "vpc_ids": [ "5a4981aa-9653-4bd1-bef5-d6bff52042e4" ] } ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

NFS shares result information.
Sample:

[
  "Current NFS shares",
  "No NFS shares"
]

shares
list