PowerCLI Reference



This cmdlet modifies the settings of the given vSAN file domains.


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

Related Commands

Online Version

Detailed Description

This cmdlet modifies the settings of the given vSAN file service domains.


NameTypeDescriptionRequired?Pipeline InputDefault Value
VsanFileServiceDomainVsanFileServiceDomain[]Specifies the list of vSAN file service domains you want to update.falseTrue (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. This 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 new name of the vSAN file service domain.falseFalse
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 default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.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.falseTrue (ByValue)
VsanFileServiceDomainVsanFileServiceDomain[]Specifies the list of VSAN file service domains you want to remove.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 list of updated VsanFileServiceDomain objects



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

Set-VsanFileServiceDomain -VsanFileServiceDomain $domain -DnsServerAddress ""
 -DnsSuffix "vmware.com" -VsanFileServerIpConfig $ipconfig1, $ipconfig2

Adds $ipconfig1 and $ipconfig2 to the $domain file service IP pool, sets the DNS server address to "", and the DNS suffix to "vmware.com"

Copyright © VMware, Inc. All rights reserved.