Vsan File Service System Vsan Cluster Remove Share Snapshot

Vsan File Service System Vsan Cluster Remove Share Snapshot

Remove a snapshot of a file share in this vSAN cluster.

Note: due to the limitation, it's not allowed to remove the latest snapshot for file service in 70U2 and an InvalidState exception will be thrown for this case.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterRemoveShareSnapshot
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanFileServiceSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
Required
"VsanClusterRemoveShareSnapshotRequestType Object"
string
shareUuid
Required

UUID of the file share to delete the snapshots.

string
snapshotName
Required

Name of the snapshot to be deleted.

cluster
Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

Authentication
This operation uses the following authentication methods.
Responses
200

A task tracking the snapshot remove progress.

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

500

InvalidState: Exception for invalid states, for example, if vSAN file service is not enabled in this cluster.

InvalidArgument: Exception for invalid input arguments, for example, if the snapshot does not exist in this cluster.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterRemoveShareSnapshot