PowerCLI Reference



This cmdlet creates a file service domain in a vSAN cluster.


New-VsanFileServiceDomain -Name <String> -Cluster <Cluster> -VsanFileServerIpConfig <VsanFileServerIpConfig[]> [-DnsServerAddress <String[]>] [-DnsSuffix <String[]>] [-RunAsync] [-Server <VIServer[]>] [-VMHost <VMHost[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet creates a file service domain in the vSAN cluster.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ClusterClusterSpecifies the vSAN cluster where you want to create the new file service domain.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
DnsServerAddressString[]Specifies the DNS server address which you want to use to resolve the hostnames within the DNS domain.nThis parameter is optional if the DNS name is provided in the access point configuration or is not required for an NFS access.falseTrue (ByValue)
DnsSuffixString[]Specifies the list of DNS server addresses that can be resolved by the DNS servers. The DNS suffix is required if the DNS servers are provided.falseTrue (ByValue)
NameStringSpecifies the name of the new vSAN file service domain. The name should be unique within a cluster. The length of the file service domain name should not exceed 256 characters.trueFalse
RunAsyncSwitchParameterIndicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the file service servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.falseFalse
VMHostVMHost[]Specifies the list of virtual machine hosts that you want to add to the file service domain. These hosts should be in the same cluster.falseFalse
VsanFileServerIpConfigVsanFileServerIpConfig[]Specifies a pool of IP addresses that will be used by vSAN file service to provide file access from multiple file servers. A minimum of one such address is needed. Considering the workload, it is recommended to have equal or greater number of IP addresses than the number of hosts in the cluster.trueTrue (ByValue)
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The newly created VsanFileServiceDomain object



-------------------------- Example 1 --------------------------

New-VsanFileServiceDomain -Name "myDomain" -Cluster $cluster
 -VsanFileServerIpConfig $ipconfig1, $ipconfig2 -DnsServerAddress ""
 -DnsSuffix "vmware.com"

Creates a new vSAN file service domain named "myDomain" in the $cluster vSAN cluster with "" as its DNS server address and "vmware.com" as its DNS suffix. The domains's IP pool are $ipconfig1 and $ipconfig2.

Copyright © VMware, Inc. All rights reserved.