NAME

Remove-DcsSnapshot

SYNOPSIS

Removes a snapshot from the configuration.

SYNTAX

Remove-DcsSnapshot -Snapshot <Object> [ -Yes] [ -Connection <String> ] [ -PipelineVariable <String> ] [ -WhatIf] [ -Confirm]

DESCRIPTION

Removes a snapshot from the configuration. When removed, the data on the snapshot is permanently destroyed and the snapshot will no longer exist.

PARAMETERS

-Snapshot<Object>: SnapshotData object, name, or ID that identifies the snapshot to remove. A snapshot in a snapshot group can also be removed using this parameter.; Required: true; Position: 1; Default value:; Accept pipeline input: true (ByValue); Accept wildcard characters: false
-Yes<SwitchParameter>: Removing a snapshot is an operation that requires confirmation. Specify this parameter to confirm your intention to remove the snapshot and prevent user interaction during scripted scenarios. If this parameter is not specified, user interaction will be required.; 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
-PipelineVariable<String>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-WhatIf<SwitchParameter>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Confirm<SwitchParameter>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false

INPUTS

SnapshotData : Object identifying and describing the snapshot.

OUTPUTS

NOTES

Also see Split-DcsSnapshot, Add-DcsSnapshot, Get-Snapshot.

EXAMPLES

-------------- Example 1 Removes a snapshot specified by name --------------

Remove-DcsSnapshot -Snapshot "Virtual disk 2 @ 8/16/2011 1:06:00 PM on SSV1" -Yes

Removes the specified snapshot named "Virtual disk 2 @ 8/16/2011 1:06:00 PM on SSV1" on the server SSV1. The Yes parameter was included to eliminate the need to confirm the operation.

-------------- Example 2 Removes all snapshots by piping objects --------------

Get-DcsSnapshot | Remove-DcsSnapshot -Yes

The cmdlet Get-DcsSnapshot is used to obtain the objects for all snapshots for the server group. The results are piped to Remove-DcsSnapshot resulting in the removal of all snapshots from the server group configuration. The Yes parameter was included to eliminate the need to confirm the operation. (Snapshots that are served to clients cannot be removed.)

-------------- Example 3 Removes a snapshot group specified by name --------------

Remove-DcsSnapshot -SnapshotGroup "VDSnapGroup1 @ 11/17/2011 11:00:04 AM" -Yes

Removes the snapshot group named "VDSnapGroup1 @ 11/17/2011 11:00:04 AM". The Yes parameter was included to eliminate the need to confirm the operation. (Snapshots that are served to clients cannot be removed.)