Give Feedback

nfs_action

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

Synopsis

Perform actions on NFS file shares such as resize and snapshot. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/NFS-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.
`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.
`nfs_id` str / required		The unique identifier of the NFS share.
`region` str / required		The slug identifier for the region where the NFS share is located.
`size_gib` int		The new size of the NFS share in GiB. Required when type is `resize`.
`snapshot_name` str		The name for the snapshot. Required when type is `snapshot`.
`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: `resize` `snapshot` `attach` `detach`	The type of action to perform.
`vpc_id` str		The VPC ID to attach/detach. Required when type is `attach` or `detach`.

Examples

- name: Resize NFS share
  digitalocean.cloud.nfs_action:
    token: "{{ token }}"
    nfs_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    region: nyc3
    type: resize
    size_gib: 200

- name: Create NFS snapshot
  digitalocean.cloud.nfs_action:
    token: "{{ token }}"
    nfs_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    region: nyc3
    type: snapshot
    snapshot_name: my-nfs-snapshot

- name: Attach NFS share to VPC
  digitalocean.cloud.nfs_action:
    token: "{{ token }}"
    nfs_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    region: nyc3
    type: attach
    vpc_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e5

- name: Detach NFS share from VPC
  digitalocean.cloud.nfs_action:
    token: "{{ token }}"
    nfs_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4
    region: nyc3
    type: detach
    vpc_id: 5a4981aa-9653-4bd1-bef5-d6bff52042e5

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	NFS action information. Sample: `{ "completed_at": null, "id": 12345678, "resource_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "resource_type": "nfs", "started_at": "2020-03-13T19:20:47.442049222Z", "status": "in-progress", "type": "resize" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	NFS action result information. Sample: `[ "Initiated resize action on NFS share", "Initiated snapshot action on NFS share" ]`

action
dict

always

NFS action information.
Sample:

{
  "completed_at": null,
  "id": 12345678,
  "resource_id": "5a4981aa-9653-4bd1-bef5-d6bff52042e4",
  "resource_type": "nfs",
  "started_at": "2020-03-13T19:20:47.442049222Z",
  "status": "in-progress",
  "type": "resize"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str