NAME

Set-DcsVirtualDiskCapacityOptimizationProperties

SYNOPSIS

Controls the use of Inline Deduplication and Inline Compression for a specified Virtual Disk.

SYNTAX

Set-DcsVirtualDiskCapacityOptimizationProperties –VirtualDisk <Object> [-DeduplicationEnabled<Nullable`1[Boolean]>] [-CompressionEnabled<Nullable`1[Boolean]>] [-OptimizeStaleOnly <Boolean>] [-StaleDataWeight <UInt32>] [-Connection <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Controls the use of Inline Deduplication and Inline Compression for a specified Virtual Disk.

PARAMETERS

-VirtualDisk <Object>
The Id of the Virtual Disk for which the properties will be configured.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-DeduplicationEnabled <Nullable`1[Boolean]>
A boolean that will indicate if the Inline Deduplication Feature will be enabled or disabled on the corresponding Virtual Disk. $True will enable the feature while $False will disable the feature.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false


-CompressionEnabled <Nullable`1[Boolean]>
A boolean that will indicate if the Inline Compression Feature will be enabled or disabled on the corresponding Virtual Disk. $True will enable the feature while $False will disable the feature.


Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-OptimizeStaleOnly [<Boolean>]
A boolean that will indicate if the optimization of stale data is applied to the corresponding virtual disk. This option can be enabled only when Inline Compression and/or Inline Deduplication are enabled.


Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-StaleDataWeight <UInt32>
Use this parameter to specify the Optimization Policy applied to stale data of the virtual disk. The valid values include "32", "64", and "96". The input is rounded to these valid values. The default value is "64" which specifies the Normal Optimization Policy. Similarly, "32" specifies Lazy and "96" specifies Aggressive Optimization Policy.


Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.


Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-InformationAction <ActionPreference>


Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false
 
-InformationVariable <String>


Required: false
Position: named
Default value:
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

 

NOTES

 

EXAMPLES


--------------------------------------------------- Example 1 -------------------------------------------------
Set-DcsVirtualDiskCapacityOptimizationProperties -VirtualDisk testvd -CompressionEnabled $true -DeduplicationEnabled $true

Demonstrates how to enable the Inline Compression and Inline Deduplication features for the virtual disk "testvd”.

VirtualDiskGroupId:
FirstHostId:B2B19966-5D73-4956-A5BF-B156E17B1548
SecondHostId:
BackupHostId:
StorageProfileId:100469DF-0BE1-40DA-874E-9F1DA5A259E3
WitnessId : 
SnapshotPoolId : 
Alias :testvd
Description : 
Size :2 GiB
SectorSize :512 B
Type :Non Mirrored
DiskStatus :Online
InquiryData :DataCore Virtual Disk DCS 0181906dd35a40e6a0fc801e4c417632
ScsiDeviceId :{96, 3, 13, 144...}
ScsiDeviceIdString :60030D9037B47E07DE03004BFBBB8B9B
RemovableMedia :False
WriteThrough :False
NVMe :False
Offline :False
Disabled :False
ManualRecovery:False
DiskLayout :DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled:True
RecoveryPriority :Regular
TPThresholdsEnabled :False
IsServed :False
SubType :Standard
MirrorTrunkMappingEnabled :False
WitnessOption :Default
PreferredServer :B2B19966-5D73-4956-A5BF-B156E17B1548
ResiliencyEnabled :False
EncryptionEnabled :False
CompressionEnabled :True
DeduplicationEnabled :True
StaleDataEnabled:False
StaleDataWeight:64
Sequencenumber :684
Id:0181906dd35a40e6a0fc801e4c417632
Caption:testvd
ExtendedCaption :testvd from Server Group
Internal:False
   

--------------------------------------------------- Example 2 -------------------------------------------------
Set-DcsVirtualDiskCapacityOptimizationProperties -VirtualDisk testvd -CompressionEnabled $true -OptimizeStaleOnly $true -StaleDataWeight 64

Demonstrates how to configure the Inline Compression specifically for the stale data of the Virtual Disk "testvd” with the Optimization Policy as Normal.

VirtualDiskGroupId:
FirstHostId:B2B19966-5D73-4956-A5BF-B156E17B1548
SecondHostId:
BackupHostId:
StorageProfileId:100469DF-0BE1-40DA-874E-9F1DA5A259E3
WitnessId : 
SnapshotPoolId : 
Alias :testvd
Description : 
Size :2 GiB
SectorSize :512 B
Type :Non Mirrored
DiskStatus :Online
InquiryData :DataCore Virtual Disk DCS 0181906dd35a40e6a0fc801e4c417632
ScsiDeviceId :{96, 3, 13, 144...}
ScsiDeviceIdString :60030D9037B47E07DE03004BFBBB8B9B
RemovableMedia :False
WriteThrough :False
NVMe :False
Offline :False
Disabled :False
ManualRecovery:False
DiskLayout :DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled:True
RecoveryPriority :Regular
TPThresholdsEnabled :False
IsServed :False
SubType :Standard
MirrorTrunkMappingEnabled :False
WitnessOption :Default
PreferredServer :B2B19966-5D73-4956-A5BF-B156E17B1548
ResiliencyEnabled :False
EncryptionEnabled :False
CompressionEnabled :True
DeduplicationEnabled :False
StaleDataEnabled :True
StaleDataWeight:64
Sequencenumber :684
Id:0181906dd35a40e6a0fc801e4c417632
Caption:testvd
ExtendedCaption :testvd from Server Group
Internal:False