Vsan File Service System Vsan Cluster Create Fs Domain

Vsan File Service System Vsan Cluster Create Fs Domain

Creates a file service domain in the vSAN cluster.

A vSAN file service domain is designed with the following properties:

  • A file service domain has a FQDN domain name (e.g., fs.mycompany.com) that client can mount.
  • It can join an Active Directory domain and use Kerberos for authentication and user ID mapping, or use AUTH_SYS to trust user ID sent from clients.
  • One more more file shares can be created in a file service domain and all these file shares have the same security/network properties of this file service domain. These file shares can be accessed from a certain network (e.g., VM Network).

In current version, only one file service domain can be created per cluster, which can be initiated when the file service is enabled.

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

Domain configuration information.

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 domain creation 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 name already configured in the 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}/VsanClusterCreateFsDomain
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