Vsan File Service System Vsan Cluster Reconfigure Fs Domain

Vsan File Service System Vsan Cluster Reconfigure Fs Domain

Updates a file service domain in the vSAN cluster.

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

The UUID of the domain to be reconfigured.

domainConfig
Required

New configuration of the domain. Only set the fields that require reconfiguration, and leave others unset.

cluster
Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: Host.Config.Storage

array of string
deleteDomainConfigFields
Optional

The domain config fields to be deleted. For example to remove directoryServerConfig from the domainConfig provide ["directoryServerConfig"] here and keep the same unset in provided domainConfig. Do note removing directoryServerConfig is only allowed when there are no active shares. Here is the list of currently supported field:

  • directoryServerConfig since 7.0U1
  • directoryServerConfig.preferredADServers since 8.0U1

Providing any other value here will cause InvalidArgumentError fault.

Authentication
This operation uses the following authentication methods.
Responses
200

A task tracking the domain reconfiguration 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 domain 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}/VsanClusterReconfigureFsDomain
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