PowerCLI Reference



This cmdlet sets Virtual SAN configuration settings for a cluster.


Set-VsanClusterConfiguration [-Configuration] <VsanClusterConfiguration[]> [-HealthCheckIntervalMinutes <Int32>] [-SpaceEfficiencyEnabled [<Boolean>]] [-PerformanceServiceEnabled [<Boolean>]] [-AllowReducedRedundancy [<Boolean>]] [-StoragePolicy <SpbmStoragePolicy>] [-StretchedClusterEnabled [<Boolean>]] [-PreferredFaultDomain <VsanFaultDomain>] [-WitnessHost <VMHost>] [-WitnessHostCacheDisk <String>] [-WitnessHostCapacityDisk <String[]>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet sets Virtual SAN configuration settings for a cluster.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ConfigurationVsanClusterConfiguration[]Specifies the configurations to modify.
This parameter supports OBN based on the names of the associated cluster. This parameter also directly accepts objects of type Cluster by silently converting them to the configuration object through ArgumentTransformationAttribute.
truetrue (ByValue)
AllowReducedRedundancyBooleanAllows reduced redundancy state.
This optional parameter is applicable to specific Virtual SAN cluster reconfigure operations that need to migrate data across cluster for changing Virtual SAN disk format. When specified, it might make the process move lesser data in order to ensure storage object accessibility, and some objects will be kept at reduced redundancy state, which means at a higher risk in case of a hardware failure during the migration process. This is applicable to the SpaceEfficiencyEnabled parameter only. The default value is False.
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
HealthCheckIntervalMinutesInt32Specifies the health check interval in minutes.
If the value of this parameter is non-zero, then health check is enabled on the cluster and health check frequency is set to the specified value. If the value of the parameter is zero, then health check is disabled on the cluster. The accepted values are from 15 minutes to one day (1440 minutes).
PerformanceServiceEnabledBooleanEnables or disables performance service on a Virtual SAN cluster.falsefalse
PreferredFaultDomainVsanFaultDomainSpecifies the preferred fault domain.
If stretched cluster configuration is enabled, this becomes the preferred fault domain for this cluster. The other fault domain in this stretched cluster becomes the secondary fault domain.
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 Connect-VIServer.falsefalse
SpaceEfficiencyEnabledBooleanEnables and disables deduplication and compression on a Virtual SAN cluster. Both deduplication and compression are enabled or disabled together.falsefalse
StoragePolicySpbmStoragePolicySpecifies the storage policy.
This parameter is applicable in the context of enabling the VirtualSAN performance service. The Virtual SAN performance history database is stored as a Virtual SAN object. The policy controls the availability, space consumption and performance of that object. If the object becomes unavailable, the performance history for that cluster will also be unavailable.
StretchedClusterEnabledBooleanEnables or disables stretched cluster configuration.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse
WitnessHostVMHostSpecifies the witness host virtual machine in case StretchedClusterEnabled is enabled. It can also be a vSphere virtual appliance called witness appliance.
Requirements for witness host:
1. Must not part of any Virtual SAN enabled cluster.
2. Must have at least one VMkernel adapter with Virtual SAN traffic enabled.
3. That adapter must be connected to all hosts in the stretched cluster.
If StretchedClusterEnabled is not specified or is false then this parameter is ignored.
WitnessHostCacheDiskStringSpecifies cache disk canonical name for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.falsefalse
WitnessHostCapacityDiskString[]Specifies the capacity disk canonical names for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.falsefalse

Return Type

The list of modified Virtual SAN configuration objects for the cluster of type VsanClusterConfiguration



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

Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -SpaceEfficiencyEnabled $true -HealthCheckIntervalMinutes 120

Enables the space efficiency on the $cluster cluster and sets the periodic health check interval to 120 minutes.

-------------- Example 2 --------------

Set-VsanClusterConfiguration -Configuration "MyCluster" -StretchedClusterEnabled $true -PreferredFaultDomain $fd -WitnessHost $vmHost

Enables stretched cluster on the "MyCluster" cluster and specifies $fd as the primary fault domain and $vmHost as the witness host.

-------------- Example 3 --------------

Set-VsanClusterConfiguration -Configuration "MyCluster" -PerformanceServiceEnabled $true -StoragePolicy $policy

Enables performance service on the "MyCluster" cluster and associates the performance history database object with the $policy storage policy.

-------------- Example 4 --------------

Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -HealthCheckIntervalMinutes 0

Disables periodic health checks on the $cluster cluster.

Copyright © VMware, Inc. All rights reserved.