NAME

Set-DcsSnapshotProperties

SYNOPSIS

Sets the properties of a snapshot.

SYNTAX

Set-DcsSnapshotProperties   -Snapshot <Object>   [ -Alias <String> ]   [ -Description <String> ]   [ -StorageProfile <String> ] [-Compressed <Boolean>]  [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

Set-DcsSnapshotProperties   -VirtualDisk <Object>   [ -Alias <String> ]   [ -Description <String> ]   [ -StorageProfile <String> ] [-Compressed <Boolean>]  [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

DESCRIPTION

Sets the properties of a snapshot. Specify the parameters to set or change. The snapshot can be identified by using either the Snapshot or VirtualDisk parameter.

PARAMETERS

-Snapshot<Object>

SnapshotData object, name (alias), or ID that identifies the snapshot.

Required: true

Position: 1

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Alias<String>

Use this parameter to change the alias (name) of the snapshot.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Description<String>

Use this parameter to set a description of the snapshot. To remove the description, use an empty string as the value; for example "".

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-StorageProfile<String>

Use this parameter to set the storage profile. Valid values in order from highest priority to lowest priority are: "Critical", "High", "Normal", "Low", and "Archive". A custom storage profile can also be set.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Compression <Boolean>

A boolean that will indicate if the Inline Compression Feature will be enabled or disabled on the corresponding Snapshot. $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

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection is 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

-VirtualDisk<Object>

VirtualDiskData object, name (alias), or ID that identifies the snapshot. The VirtualDiskData object can be obtained from the cmdlet Get-DcsVirtualDisk.

Required: true

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

SnapshotData : Object that identifies the snapshot.

OUTPUTS

VirtualDiskData : Object that identifies the snapshot virtual disk.

NOTES

Also see related cmdlets: Set-DcsSnapshotMapStore, Set-DcsSnapshotPool.

EXAMPLES

Set-DcsSnapshotProperties -Snapshot "VD1 S1" -Alias "Virtual disk 1 Snap 053116 -Compressed $True"
		

$Snaps = Get-DcsVirtualDisk -Kind Snapshot
ForEach ($s in $Snaps) {Set-DcsSnapshotProperties -VirtualDisk $s.Id -StorageProfile "High"}