Set-VsanClusterConfiguration

Synopsis

Syntax

Related Commands

Online Version

Get-VsanClusterConfiguration

Detailed Description

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Configuration	VsanClusterConfiguration[]	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.	true	True (ByValue)
AddSilentHealthCheck	String[]	Specifies the health checks list you want to add to the silent list.	false	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.	false	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.	false	False
CustomizedSwapObjectEnabled	Boolean	Enables and disables customer's fully control the policy 'proportionalCapacity' for swap object The default value is False.	false	False
DefaultIncomingChapSecret	SecureString	Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.	false	False
DefaultIncomingChapUser	String	Specifies the default CHAP user name for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.	false	False
DefaultIscsiNetworkInterface	String	Specifies the default VMkernel network interface which handles the iSCSI traffic. Can be overridden per target. 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.	false	False
DefaultIscsiTargetAuthenticationType	VsanIscsiTargetAuthenticationType	Specifies the default authentication type for vSAN iSCSI targets in this cluster.	false	False
DefaultIscsiTcpPort	Int32	Specifies the default network port for iSCSI targets. Can be overridden per target. If not provided, the default port 3260 is used. The server automatically opens the firewall for the specified port.	false	False
DefaultOutgoingChapSecret	SecureString	Specifies the default CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.	false	False
DefaultOutgoingChapUser	String	Specifies the default CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.	false	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 VMs will take effect and succeed immediately; And if it is switched from enabled to disabled dynamically, running VMs residing on this vSAN datastore won't know this change until VM rebooting happens. The default value is False	false	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).	false	False
IscsiTargetServiceEnabled	Boolean	Enables or disables the iSCSI target service on a vSAN cluster.	false	False
LargeClusterSupported	Boolean	Enables and disables large cluster supported. Please be noted, if this option is changed before vSAN enabled, it can be applied at host side immediately; but if it is changed on a vSAN cluster, all hosts are required to reboot to apply this change. After setting this, please review the vSAN health check result, which can help to figure out which host requires rebooting. The default value is False.	false	False
ObjectRepairTimerMinutes	Int32	This configuration is to determine delay time in minutes for vSAN, to wait for absent component to come back before starting repair it. Allowed values: 0 to 4294967295 Default value: 60.	false	False
PerformanceServiceEnabled	Boolean	Enables or disables performance service on a vSAN cluster.	false	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.	false	False
RemoveSilentHealthCheck	String[]	Specifies the health checks list you want to remove from the silent list.	false	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.	false	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 Connect-VIServer.	false	False
SiteReadLocalityEnabled	Boolean	Enables and disables site read locality. The default value is True.	false	False
SpaceEfficiencyEnabled	Boolean	Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are enabled or disabled together.	false	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 will also be unavailable.	false	False
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 of 1 or more.	false	False
StretchedClusterEnabled	Boolean	Enables or disables stretched cluster configuration.	false	False
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	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.	false	False
WitnessHostCacheDisk	String	Specifies cache disk canonical name for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.	false	False
WitnessHostCapacityDisk	String[]	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.	false	False

Name

Type

Description

Required?

Pipeline Input

Default Value

Configuration

VsanClusterConfiguration[]

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.

true

True (ByValue)

AddSilentHealthCheck

String[]

Specifies the health checks list you want to add to the silent list.

false

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.

false

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.

false

False

CustomizedSwapObjectEnabled

Boolean

Enables and disables customer's fully control the policy 'proportionalCapacity' for swap object The default value is False.

false

False

DefaultIncomingChapSecret

SecureString

Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.

false

False

DefaultIncomingChapUser

String

Specifies the default CHAP user name for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.

false

False

DefaultIscsiNetworkInterface

String

Specifies the default VMkernel network interface which handles the iSCSI traffic. Can be overridden per target. 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.

false

False

DefaultIscsiTargetAuthenticationType

VsanIscsiTargetAuthenticationType

Specifies the default authentication type for vSAN iSCSI targets in this cluster.

false

False

DefaultIscsiTcpPort

Int32

Specifies the default network port for iSCSI targets. Can be overridden per target. If not provided, the default port 3260 is used. The server automatically opens the firewall for the specified port.

false

False

DefaultOutgoingChapSecret

SecureString

Specifies the default CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.

false

False

DefaultOutgoingChapUser

String

Specifies the default CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.

false

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 VMs will take effect and succeed immediately; And if it is switched from enabled to disabled dynamically, running VMs residing on this vSAN datastore won't know this change until VM rebooting happens. The default value is False

false

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).

false

False

IscsiTargetServiceEnabled

Boolean

Enables or disables the iSCSI target service on a vSAN cluster.

false

False

LargeClusterSupported

Boolean

Enables and disables large cluster supported. Please be noted, if this option is changed before vSAN enabled, it can be applied at host side immediately; but if it is changed on a vSAN cluster, all hosts are required to reboot to apply this change. After setting this, please review the vSAN health check result, which can help to figure out which host requires rebooting. The default value is False.

false

False

ObjectRepairTimerMinutes

Int32

This configuration is to determine delay time in minutes for vSAN, to wait for absent component to come back before starting repair it. Allowed values: 0 to 4294967295 Default value: 60.

false

False

PerformanceServiceEnabled

Boolean

Enables or disables performance service on a vSAN cluster.

false

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.

false

False

RemoveSilentHealthCheck

String[]

Specifies the health checks list you want to remove from the silent list.

false

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.

false

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 Connect-VIServer.

false

False

SiteReadLocalityEnabled

Boolean

Enables and disables site read locality. The default value is True.

false

False

SpaceEfficiencyEnabled

Boolean

Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are enabled or disabled together.

false

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 will also be unavailable.

false

False

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 of 1 or more.

false

False

StretchedClusterEnabled

Boolean

Enables or disables stretched cluster configuration.

false

False

WhatIf

SwitchParameter

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

false

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.

false

False

WitnessHostCacheDisk

String

Specifies cache disk canonical name for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.

false

False

WitnessHostCapacityDisk

String[]

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.

false

False

Return Type

Notes

Examples

-------------------------- 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

-------------------------- Example 5 --------------------------

Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -SiteReadLocalityEnabled $true -CustomizedSwapObjectEnabled $true -ObjectRepairTimerInMinutes 100

Disables periodic health checks on the $cluster cluster.

PowerCLI Reference

Synopsis