NAME

Set-DcsDataProtectionProperties

SYNOPSIS

Sets the history log size and retention period for a virtual disk with Continuous Data Protection (CDP).

SYNTAX

Set-DcsDataProtectionProperties   -VirtualDisk <Object>   [ -HistorySize <DataSize> ]   [ -RetentionPeriod <TimeSpan> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Sets the history log size and retention period for a virtual disk with Continuous Data Protection (CDP).

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk to protect.

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

-HistorySize<DataSize>
The maximum size of the history log. Valid values consist of the number followed by the unit of measurement (MiB, GiB, TiB). Decimals may be used. For example, "10GiB", "20.5GiB", and "5000MiB" are valid sizes. The history log size can range from a minimum of 8GiB up to 1TiB. If not specified, the history log size will be set to the default size which is 5% of the size of the CDP-enabled virtual disk or 8GiB, whichever is larger. Setting the value of this parameter to zero will also set the maximum history log size to the default size.

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

-RetentionPeriod<TimeSpan>
Use this parameter to set the retention period of a virtual disk to a period that is less than the licensed retention period. The value should be in hours and can be entered as a Timespan object (see Windows Help for New-Object) or as a string consisting of numbers consisting of days, hours, minutes, and seconds. For example, "02:00:00" would represent two hours and "02:00:00:00" would represent two days. Minutes and seconds in the parameter value will be rounded up to the hour. For example, if the value entered is "02:30:15" the retention period will be set to three hours. To reset the value to the licensed retention period, use zero as the value or omit the value for this parameter. Note: To get the retention period setting, use the cmdlet Get-DcsLogicalDisk specifying the server and virtual disk. See the RetentionTime field in the returned object. The value is displayed in milliseconds.

Required: false
Position: 3
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

-PipelineVariable<String>

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

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

NOTES

Also see Get-DcsVirtualDisk, Enable-DcsDataProtection, Disable-DcsDataProtection

EXAMPLES


-------------- Example 1 Sets the maximum history size and the retention period for a CDP-enabled virtual disk --------------
Set-DcsDataProtectionProperties -VirtualDisk "Virtual disk 1" -HistorySize 20GiB -RetentionPeriod 02:00:00
		

The maximum history log for the virtual disk named "Virtual disk 1" is set to be 20 GiB. The retention period is set to 2 hours, which is less than the licensed retention time for the server group.

VirtualDiskGroupId:
FirstHostId:16E92F64-1A7B-43C8-8FEA-40F508A99B95
SecondHostId:8D3DE096-E3B4-427D-B0E1-4EC96C45F6E1
BackupHostId:
StorageProfileId:100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId:
Alias:Virtual disk 1
Description:
Size:10 GiB
Type:MultiPathMirrored
DiskStatus:Online
InquiryData:DataCore Virtual Disk DCS 8edabe5777a0473bbd032b2bfcb28089
ScsiDeviceId:{96, 3, 13, 144...}
ScsiDeviceIdString:60030D903C0CB706A1D1C3F91CBD2DC6
RemovableMedia:False
WriteThrough:False
Offline:False
Disabled:False
ManualRecovery:False
DiskLayout:DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled:True
RecoveryPriority:Regular
IsServed:False
SubType:Standard
Sequencenumber:2447
Id:8edabe5777a0473bbd032b2bfcb28089
Caption:Virtual disk 1
ExtendedCaption:Virtual disk 1 from Group 1
Internal:False