< Back
Set-VsanClusterConfiguration
Post
NAME Set-VsanClusterConfiguration
SYNOPSIS
This cmdlet sets vSAN configuration settings for a cluster.
SYNTAX
Set-VsanClusterConfiguration [-Configuration] <VsanClusterConfiguration[]> [-AddSilentHealthCheck <String[]>]
[-AllowReducedRedundancy <Boolean>] [-DefaultIncomingChapSecret <SecureString>] [-DefaultIncomingChapUser
<String>] [-DefaultIscsiNetworkInterface <String>] [-DefaultIscsiTargetAuthenticationType
<VsanIscsiTargetAuthenticationType>] [-DefaultIscsiTcpPort <Int32>] [-DefaultOutgoingChapSecret <SecureString>]
[-DefaultOutgoingChapUser <String>] [-GuestTrimUnmap <Boolean>] [-SiteReadLocalityEnabled <Boolean>]
[-CustomizedSwapObjectEnabled <Boolean>] [-LargeClusterSupported <Boolean>] [-ObjectRepairTimerMinutes <Int32>]
[-HealthCheckIntervalMinutes <Int32>] [-IscsiTargetServiceEnabled <Boolean>] [-PerformanceServiceEnabled
<Boolean>] [-PreferredFaultDomain <VsanFaultDomain>] [-RemoveSilentHealthCheck <String[]>] [-ResyncThrottlingMbps
<Int32>] [-Server <VIServer[]>] [-SpaceEfficiencyEnabled <Boolean>] [-StoragePolicy <SpbmStoragePolicy>]
[-StoragePolicyForIscsiTargetService <SpbmStoragePolicy>] [-StretchedClusterEnabled <Boolean>] [-WitnessHost
<VMHost>] [-WitnessHostCacheDisk <String>] [-WitnessHostCapacityDisk <String[]>] [-VsanBaselinePreference
<VsanBaselinePreferenceType>] [-ProactiveRebalanceEnabled <Boolean>] [-ProactiveRebalanceThreshold <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet sets vSAN configuration settings for a cluster.
PARAMETERS
-AddSilentHealthCheck <String[]>
Specifies the health checks list you want to add to the silent list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AllowReducedRedundancy <Boolean>
Allows reduced redundancy state. This optional parameter is applicable to specific vSAN cluster reconfigure
operations that need to migrate data across cluster for changing vSAN 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Configuration <VsanClusterConfiguration[]>
Specifies the configurations that you want 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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-DefaultIncomingChapSecret <SecureString>
Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type
is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIncomingChapUser <String>
Specifies the default CHAP user name for the iSCSI targets on this cluster. Applicable when the authentication
type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiNetworkInterface <String>
Specifies the default VMkernel network interface which handles the iSCSI traffic. This can be overridden per
target. It is mandatory if IscsiTargetServiceEnabled is specified as $true. This parameter accepts an object
of type HostVMKernelVirtualNic by silently converting it to the string name by using
ArgumentTransformationAttribute.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiTargetAuthenticationType <VsanIscsiTargetAuthenticationType>
Specifies the default authentication type for the vSAN iSCSI targets in this cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiTcpPort <Int32>
Specifies the default network port for the iSCSI targets. This can be overridden per target. If not provided,
the default port 3260 is used. The server automatically opens the firewall for the specified port.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultOutgoingChapSecret <SecureString>
Specifies the default CHAP user secret you want to attach to the initiator. This is applicable when the
authentication type is MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultOutgoingChapUser <String>
Specifies the default CHAP user name you want to attach to the initiator. This is applicable when the
authentication type is MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GuestTrimUnmap <Boolean>
Specifies the TRIM/UNMAP for the respective ATA and SCSI protocols. If this setting is switched from disabled
to enabled for any unmap request to vSAN datastore from powered on virtual machines, this will take effect and
succeed immediately. If it is switched from enabled to disabled dynamically, running virtual machines residing
on this vSAN datastore will understand this change until virtual machine rebooting happens. The default value
is False.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-SiteReadLocalityEnabled <Boolean>
Enables and disables site read locality. The default value is True.
Required? false
Position? named
Default value True
Accept pipeline input? False
Accept wildcard characters? false
-CustomizedSwapObjectEnabled <Boolean>
Enables and disables customer's fully control the policy 'proportionalCapacity' for swap object The default
value is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LargeClusterSupported <Boolean>
Enables and disables large cluster supported. If this option is changed before vSAN enabled, it can be applied
at host side immediatelyl. If it is changed on a vSAN cluster, all hosts are required to reboot to apply the
change. After setting this, review the vSAN health check result, which can help to figure out which host
requires rebooting. The default value is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ObjectRepairTimerMinutes <Int32>
Determines the delay time in minutes for the missing component to come back before starting the repair
process. Allowed values: 0 to 4294967295 Default value: 60.
Required? false
Position? named
Default value 60.
Accept pipeline input? False
Accept wildcard characters? false
-HealthCheckIntervalMinutes <Int32>
Specifies 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).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IscsiTargetServiceEnabled <Boolean>
Enables or disables the iSCSI target service on a vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PerformanceServiceEnabled <Boolean>
Enables or disables performance service on a vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PreferredFaultDomain <VsanFaultDomain>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-RemoveSilentHealthCheck <String[]>
Specifies the health checks list you want to remove from the silent list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResyncThrottlingMbps <Int32>
Specifies the resynchronization traffic limit in Mbps for each disk group in the cluster. The valid values are
from 1 to 512. If the value of the parameter is zero, throttling resynchronization traffic limits are disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SpaceEfficiencyEnabled <Boolean>
Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are
enabled or disabled together.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StoragePolicy <SpbmStoragePolicy>
Specifies the storage policy. This parameter is applicable in the context of enabling the VirtualSAN
performance service. The vSAN performance history database is stored as a vSAN object. The policy controls the
availability, space consumption, and performance of that object. If the object becomes unavailable, the
performance history for that cluster is also unavailable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicyForIscsiTargetService <SpbmStoragePolicy>
Specifies the storage policy for the iSCSI target service. When you enable the iSCSI target service, vSAN
creates a home object that stores metadata for the iSCSI target service. The storage policy for the home
object should have a number of failures to tolerate.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StretchedClusterEnabled <Boolean>
Enables or disables stretched cluster configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WitnessHost <VMHost>
Specifies 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: - Must not be part of any vSAN-enabled cluster.
- Must have at least one VMkernel adapter with vSAN traffic enabled.
- That adapter must be connected to all hosts in the stretched cluster.
In vSAN versions earlier than 6.6, this parameter is only applicable when enabling stretched cluster. If
StretchedClusterEnabled is not specified or is false, then this parameter is ignored.
In vSAN 6.7 or later, this parameter can be specified to update the witness host in a stretched cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-WitnessHostCacheDisk <String>
Specifies cache disk canonical name for the disk group that you want to create on the witness host. This
parameter accepts ScsiLun or VMHostDisk objects through an argument transformation.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WitnessHostCapacityDisk <String[]>
Specifies the capacity disk canonical names for the disk group that you want to create on the witness host.
This parameter accepts ScsiLun or VMHostDisk objects through an argument transformation.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VsanBaselinePreference <VsanBaselinePreferenceType>
Specifies the baseline preference policy for the current vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProactiveRebalanceEnabled <Boolean>
Specifies whether proactive rebalance is enabled. If the value is set to True, rebalance data movement starts
when the following requirements are met within the vSAN cluster: 1. Current disk fullness - lowest disk
fullness > proactive threshold. 2. Current disk fullness > mean disk fulless within cluster. The default value
is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProactiveRebalanceThreshold <Int32>
Indicates the extent of the imbalance that the cluster can tolerate in percentage. If the disk imbalance
(current disk fullness - lowest disk fullness) is below the rebalance threshold, the proactive rebalance will
not be triggered. The allowed values are from 25 to 75. The default value is 30.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The list of modified vSAN configuration objects for the cluster of type VsanClusterConfiguration
NOTES
-------------------------- 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 the health check service on the "MyCluster" cluster.
-------------------------- Example 5 --------------------------
Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -SiteReadLocalityEnabled $true
-CustomizedSwapObjectEnabled $true -ObjectRepairTimerInMinutes 100
Disables periodic health checks on the $cluster cluster.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ation.html
Get-VsanClusterConfiguration
SYNOPSIS
This cmdlet sets vSAN configuration settings for a cluster.
SYNTAX
Set-VsanClusterConfiguration [-Configuration] <VsanClusterConfiguration[]> [-AddSilentHealthCheck <String[]>]
[-AllowReducedRedundancy <Boolean>] [-DefaultIncomingChapSecret <SecureString>] [-DefaultIncomingChapUser
<String>] [-DefaultIscsiNetworkInterface <String>] [-DefaultIscsiTargetAuthenticationType
<VsanIscsiTargetAuthenticationType>] [-DefaultIscsiTcpPort <Int32>] [-DefaultOutgoingChapSecret <SecureString>]
[-DefaultOutgoingChapUser <String>] [-GuestTrimUnmap <Boolean>] [-SiteReadLocalityEnabled <Boolean>]
[-CustomizedSwapObjectEnabled <Boolean>] [-LargeClusterSupported <Boolean>] [-ObjectRepairTimerMinutes <Int32>]
[-HealthCheckIntervalMinutes <Int32>] [-IscsiTargetServiceEnabled <Boolean>] [-PerformanceServiceEnabled
<Boolean>] [-PreferredFaultDomain <VsanFaultDomain>] [-RemoveSilentHealthCheck <String[]>] [-ResyncThrottlingMbps
<Int32>] [-Server <VIServer[]>] [-SpaceEfficiencyEnabled <Boolean>] [-StoragePolicy <SpbmStoragePolicy>]
[-StoragePolicyForIscsiTargetService <SpbmStoragePolicy>] [-StretchedClusterEnabled <Boolean>] [-WitnessHost
<VMHost>] [-WitnessHostCacheDisk <String>] [-WitnessHostCapacityDisk <String[]>] [-VsanBaselinePreference
<VsanBaselinePreferenceType>] [-ProactiveRebalanceEnabled <Boolean>] [-ProactiveRebalanceThreshold <Int32>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet sets vSAN configuration settings for a cluster.
PARAMETERS
-AddSilentHealthCheck <String[]>
Specifies the health checks list you want to add to the silent list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AllowReducedRedundancy <Boolean>
Allows reduced redundancy state. This optional parameter is applicable to specific vSAN cluster reconfigure
operations that need to migrate data across cluster for changing vSAN 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Configuration <VsanClusterConfiguration[]>
Specifies the configurations that you want 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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-DefaultIncomingChapSecret <SecureString>
Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type
is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIncomingChapUser <String>
Specifies the default CHAP user name for the iSCSI targets on this cluster. Applicable when the authentication
type is Chap or MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiNetworkInterface <String>
Specifies the default VMkernel network interface which handles the iSCSI traffic. This can be overridden per
target. It is mandatory if IscsiTargetServiceEnabled is specified as $true. This parameter accepts an object
of type HostVMKernelVirtualNic by silently converting it to the string name by using
ArgumentTransformationAttribute.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiTargetAuthenticationType <VsanIscsiTargetAuthenticationType>
Specifies the default authentication type for the vSAN iSCSI targets in this cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultIscsiTcpPort <Int32>
Specifies the default network port for the iSCSI targets. This can be overridden per target. If not provided,
the default port 3260 is used. The server automatically opens the firewall for the specified port.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultOutgoingChapSecret <SecureString>
Specifies the default CHAP user secret you want to attach to the initiator. This is applicable when the
authentication type is MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultOutgoingChapUser <String>
Specifies the default CHAP user name you want to attach to the initiator. This is applicable when the
authentication type is MutualChap.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GuestTrimUnmap <Boolean>
Specifies the TRIM/UNMAP for the respective ATA and SCSI protocols. If this setting is switched from disabled
to enabled for any unmap request to vSAN datastore from powered on virtual machines, this will take effect and
succeed immediately. If it is switched from enabled to disabled dynamically, running virtual machines residing
on this vSAN datastore will understand this change until virtual machine rebooting happens. The default value
is False.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-SiteReadLocalityEnabled <Boolean>
Enables and disables site read locality. The default value is True.
Required? false
Position? named
Default value True
Accept pipeline input? False
Accept wildcard characters? false
-CustomizedSwapObjectEnabled <Boolean>
Enables and disables customer's fully control the policy 'proportionalCapacity' for swap object The default
value is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LargeClusterSupported <Boolean>
Enables and disables large cluster supported. If this option is changed before vSAN enabled, it can be applied
at host side immediatelyl. If it is changed on a vSAN cluster, all hosts are required to reboot to apply the
change. After setting this, review the vSAN health check result, which can help to figure out which host
requires rebooting. The default value is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ObjectRepairTimerMinutes <Int32>
Determines the delay time in minutes for the missing component to come back before starting the repair
process. Allowed values: 0 to 4294967295 Default value: 60.
Required? false
Position? named
Default value 60.
Accept pipeline input? False
Accept wildcard characters? false
-HealthCheckIntervalMinutes <Int32>
Specifies 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).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IscsiTargetServiceEnabled <Boolean>
Enables or disables the iSCSI target service on a vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PerformanceServiceEnabled <Boolean>
Enables or disables performance service on a vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PreferredFaultDomain <VsanFaultDomain>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-RemoveSilentHealthCheck <String[]>
Specifies the health checks list you want to remove from the silent list.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResyncThrottlingMbps <Int32>
Specifies the resynchronization traffic limit in Mbps for each disk group in the cluster. The valid values are
from 1 to 512. If the value of the parameter is zero, throttling resynchronization traffic limits are disabled.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SpaceEfficiencyEnabled <Boolean>
Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are
enabled or disabled together.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StoragePolicy <SpbmStoragePolicy>
Specifies the storage policy. This parameter is applicable in the context of enabling the VirtualSAN
performance service. The vSAN performance history database is stored as a vSAN object. The policy controls the
availability, space consumption, and performance of that object. If the object becomes unavailable, the
performance history for that cluster is also unavailable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-StoragePolicyForIscsiTargetService <SpbmStoragePolicy>
Specifies the storage policy for the iSCSI target service. When you enable the iSCSI target service, vSAN
creates a home object that stores metadata for the iSCSI target service. The storage policy for the home
object should have a number of failures to tolerate.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StretchedClusterEnabled <Boolean>
Enables or disables stretched cluster configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WitnessHost <VMHost>
Specifies 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: - Must not be part of any vSAN-enabled cluster.
- Must have at least one VMkernel adapter with vSAN traffic enabled.
- That adapter must be connected to all hosts in the stretched cluster.
In vSAN versions earlier than 6.6, this parameter is only applicable when enabling stretched cluster. If
StretchedClusterEnabled is not specified or is false, then this parameter is ignored.
In vSAN 6.7 or later, this parameter can be specified to update the witness host in a stretched cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-WitnessHostCacheDisk <String>
Specifies cache disk canonical name for the disk group that you want to create on the witness host. This
parameter accepts ScsiLun or VMHostDisk objects through an argument transformation.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WitnessHostCapacityDisk <String[]>
Specifies the capacity disk canonical names for the disk group that you want to create on the witness host.
This parameter accepts ScsiLun or VMHostDisk objects through an argument transformation.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VsanBaselinePreference <VsanBaselinePreferenceType>
Specifies the baseline preference policy for the current vSAN cluster.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProactiveRebalanceEnabled <Boolean>
Specifies whether proactive rebalance is enabled. If the value is set to True, rebalance data movement starts
when the following requirements are met within the vSAN cluster: 1. Current disk fullness - lowest disk
fullness > proactive threshold. 2. Current disk fullness > mean disk fulless within cluster. The default value
is False.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProactiveRebalanceThreshold <Int32>
Indicates the extent of the imbalance that the cluster can tolerate in percentage. If the disk imbalance
(current disk fullness - lowest disk fullness) is below the rebalance threshold, the proactive rebalance will
not be triggered. The allowed values are from 25 to 75. The default value is 30.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The list of modified vSAN configuration objects for the cluster of type VsanClusterConfiguration
NOTES
-------------------------- 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 the health check service on the "MyCluster" cluster.
-------------------------- Example 5 --------------------------
Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -SiteReadLocalityEnabled $true
-CustomizedSwapObjectEnabled $true -ObjectRepairTimerInMinutes 100
Disables periodic health checks on the $cluster cluster.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ation.html
Get-VsanClusterConfiguration