share_actions
Creates, updates, deletes, gets or lists a share_actions resource.
Overview
| Name | share_actions |
| Type | Resource |
| Id | digitalocean.storage.share_actions |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
nfs_create_action | exec | nfs_id, type | To execute an action (such as resize) on a specified NFS share, send a POST request to /v2/nfs/{nfs_id}/actions. In the JSON body to the request, set the type attribute to on of the supported action types:| Action | Details | | -------------------------------- | ----------- | | resize | Resizes an NFS share. Set the size_gib attribute to a desired value in GiB || snapshot | Takes a snapshot of an NFS share || attach | Attaches an NFS share to a VPC. Set the vpc_id attribute to the desired VPC ID || detach | Detaches an NFS share from a VPC. Set the vpc_id attribute to the desired VPC ID || reassign | Reassigns an NFS share from one VPC to another. Set the old_vpc_id and new_vpc_id attributes to the desired VPC IDs || switch_performance_tier | Switches the performance tier of an NFS share. Set the performance_tier attribute to the desired tier (e.g., standard, high) | |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
nfs_id | string | The unique ID of the NFS share (example: 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d) |
Lifecycle Methods
- nfs_create_action
To execute an action (such as resize) on a specified NFS share,
send a POST request to /v2/nfs/{nfs_id}/actions. In the JSON body
to the request, set the type attribute to on of the supported action types:
| Action | Details |
| -------------------------------- | ----------- |
| resize | Resizes an NFS share. Set the size_gib attribute to a desired value in GiB |
| snapshot | Takes a snapshot of an NFS share |
| attach | Attaches an NFS share to a VPC. Set the vpc_id attribute to the desired VPC ID |
| detach | Detaches an NFS share from a VPC. Set the vpc_id attribute to the desired VPC ID |
| reassign | Reassigns an NFS share from one VPC to another. Set the old_vpc_id and new_vpc_id attributes to the desired VPC IDs |
| switch_performance_tier | Switches the performance tier of an NFS share. Set the performance_tier attribute to the desired tier (e.g., standard, high) |
EXEC digitalocean.storage.share_actions.nfs_create_action
@nfs_id='{{ nfs_id }}' --required
@@json=
'{
"type": "{{ type }}",
"region": "{{ region }}",
"params": "{{ params }}"
}'
;