Cmdlets > Remove-DtSnapshot

Remove-DtSnapshot

Removes a snapshot

Syntax

Remove-DtSnapshot [-ServiceHost] <Server> [-JobId] <Guid> [-SnapshotId] <Guid> [-ConnectionId <Guid>] [<CommonParameters>]

 

Remove-DtSnapshot [-ServiceHost] <Server> [-JobId] <Guid> [-Snapshot] <SnapshotEntry> [-ConnectionId <Guid>] [<CommonParameters>]

 

Detailed Description

This cmdlet removes a Double-Take snapshot from the specified server.

Parameters

Name Type Description Required Pipeline Input
Service
Host
Server

Specify the server object returned from the New-DtServer cmdlet. For this cmdlet, the -ServiceHost should be your target server.

true false
JobId Guid

Specify the job GUID returned from the New-DtJob cmdlet or the Id within the job information returned from the Get-DtJob cmdlet.

true false
SnapshotId

Guid

Specify the snapshot GUID returned from the Get-DtSnapshot cmdlet.

true false
Connection
Id
ConnectionId

Specify the connection ID returned from the Get-DtConnectionIds cmdlet.

false false
Snapshot SnapshotEntry

Specify the snapshot entry object returned from the Get-DtSnapshot cmdlet.

true

false

Outputs

ActivityToken

Examples

$DtServerObjectBeta = New-DtServer -Name beta -UserName domain\administrator -Password password

$DtJobForAlpha = Get-DtJob -ServiceHost $DtServerObjectBeta | Where-Object { $_.Statistics.CoreConnectionDetails.SourceMachineName -eq $DtServerObjectAlpha}

$DtSnaps = Get-DtSnapshot -ServiceHost $DtServerObjectBeta -JobId $DtJobForAlpha.Id

$FirstSnap=$DtSnaps | Select-Object -First 1

Remove-DtSnapshot -ServiceHost $DtServerObjectBeta -SnapshotId $FirstSnap.Id

Disconnect-DtServer -ServiceHost $DtServerObjectBeta

A server object is created for the server beta using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectBeta. The job(s) are retrieved from DtServerObjectBeta, but only the job information where the source machine name is equivalent to the name stored in the variable DtServerObjectAlpha is retrieved. That information is then stored in the variable DtJobForAlpha. The snapshots available for the job are stored in DtSnaps and then the first snapshot is stored in FirstSnap. That first snapshot is then deleted. The connections for the server object are then closed.