Vsan File Service System Vsan Reconfigure File Share

Vsan File Service System Vsan Reconfigure File Share

Reconfigures a file share in this vSAN cluster.

All the configurations of a vSAN file share can be reconfigured through this API, except the file service domain.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanReconfigureFileShare
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
VsanReconfigureFileShareRequestType of type(s) application/json
Required 
"VsanReconfigureFileShareRequestType Object"
string
shareUuid
Required

The UUID of the file share to be reconfigured.

config
Required

The file services configuration. Only set the fields that require reconfiguration, and leave the others unset. This API will update or create the labels specified in the config. Labels to be deleted should be specified in the 'deleteLabelKeys' parameter. Other labels will remain intact.

cluster
Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

array of string
deleteLabelKeys
Optional

The keys of share labels to be deleted. If a specified label key does not exist in the file share, the deletion of this label will be ignored.

boolean
force
Optional

The force flag is to force the reconfiguration of a vSphere managed file share, for example, the file share managed by Cloud Native Storage (CNS) service.

Authentication
This operation uses the following authentication methods.
Responses
200

A task tracking the share reconfiguring progress.

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

500

InvalidState: Exception when vSAN file service is not enabled in this cluster.

InvalidArgument: Exception for invalid input arguments, for example, if the file share 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}/VsanReconfigureFileShare
On This Page
V San Service Api Operations
POST
Vsan File Service System Vsan Cluster Create Fs Domain
POST
Vsan File Service System Vsan Create File Share
POST
Vsan File Service System Vsan Cluster Create Share Snapshot
POST
Vsan File Service System Vsan Download File Service Ovf
POST
Vsan File Service System Vsan Find Ovf Download Url
POST
Vsan File Service System Vsan Perform File Service Enable Preflight Check
POST
Vsan File Service System Vsan Cluster Query Fs Domains
POST
Vsan File Service System Vsan Query File Service Ovfs
POST
Vsan File Service System Vsan Cluster Query Share Snapshots
POST
Vsan File Service System Vsan Cluster Query File Shares
POST
Vsan File Service System Vsan Rebalance File Service
POST
Vsan File Service System Vsan Cluster Reconfigure Fs Domain
POST
Vsan File Service System Vsan Reconfigure File Share
POST
Vsan File Service System Vsan Cluster Remove Fs Domain
POST
Vsan File Service System Vsan Cluster Remove Share
POST
Vsan File Service System Vsan Cluster Remove Share Snapshot
POST
Vsan File Service System Vsan Upgrade Fsvm