PowerCLI Reference



This cmdlet starts an encryption configuration on a vSAN cluster.


Start-VsanEncryptionConfiguration [-Cluster] <Cluster[]> [-AllowReducedRedundancy <Boolean>] [-DeepRekey] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Start-VsanEncryptionConfiguration [-Cluster] <Cluster[]> [-AllowReducedRedundancy <Boolean>] [-EncryptionEnabled <Boolean>] [-EraseDisksBeforeUse <Boolean>] [-KeyProvider <KmsCluster>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Start-VsanEncryptionConfiguration [-Cluster] <Cluster[]> [-AllowReducedRedundancy <Boolean>] [-Server <VIServer[]>] [-ShallowRekey] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet starts an encryption configuration on a vSAN cluster.

The encryption configuration includes the following actions: - Enable or disable the encryption

- Change the key provider

- Perform a deep rekey

- Perform a shallow rekey


NameTypeDescriptionRequired?Pipeline InputDefault Value
ClusterCluster[]Specifies the vSAN cluster on which you want to start the encryption configuration of the vSAN objects.trueTrue (ByValue)
AllowReducedRedundancyBooleanThis optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.falseFalse
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
DeepRekeySwitchParameterSpecifies that you want to perform a deep rekey operation. When a deep rekey operation runs, all disks are re-encrypted with new data encryption keys. The deep rekey operation takes long time to finish.falseFalse
EncryptionEnabledBooleanSpecifies whether you want to enable or disable the encryption.falseFalse
EraseDisksBeforeUseBooleanSpecifies whether the disk should be formatted when a normal disk is converted to an encrypted disk, it is claimed as encrypted disk, or it runs deep rekey. If the value of this parameter is $true, every sector on the disk is written with random data. Disk cleanup reduces the possibility of data leak and increases the potential intruder's cost to reveal sensitive data. Turn the disk cleanup on only when necessary, as it takes long time to finish. If the value of this parameter is $false, the disk will not be formatted.falseFalse
KeyProviderKmsClusterSpecifies the key provider you want to use for the encryption.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
ShallowRekeySwitchParameterSpecifies that you want to perform a shallow rekey operation. When a shallow rekey operation runs, only the key encryption key (KEK) is changed and the data encryption keys (DEKs) are rewrapped with new key encryption keys.falseFalse
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 task object to track the operations on clusters



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

Start-VsanEncryptionConfiguration -Cluster $vsanCluster -EncryptionEnabled $true -KeyProvider 'ThalesCluster'

Enables the encryption on the $vsanCluster vSAN cluster with 'ThalesCluster' as the key provider.

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

Start-VsanEncryptionConfiguration -Cluster $vsanCluster -EncryptionEnabled $false

Disables the encryption on the $vsanCluster vSAN cluster.

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

Start-VsanEncryptionConfiguration -Cluster $vsanCluster -DeepRekey

Performs a deep rekey operation on all disks of the $vsanCluster vSAN cluster. All data on the disks is re-encrypted.

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

Start-VsanEncryptionConfiguration -Cluster $vsanCluster -ShallowRekey

Performs a shallow rekey operation on all disks of the $vsanCluster vSAN cluster. All data encryption keys are rewrapped with a new key encryption key. Data on the disks is not re-encrypted.

Copyright © VMware, Inc. All rights reserved.