Start-DPMTapeErase
Start-DPMTapeErase
Deletes the contents of a tape.
Syntax
Parameter Set: Default
Start-DPMTapeErase [-Tape] <Media[]> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-DPMTapeErase cmdlet deletes the contents of a tape in System Center 2012 – Data Protection Manager (DPM).
You can reuse an expired tape in DPM without first deleting the data on the tape.
Parameters
-JobStateChangedEventHandler<JobStateChangedEventHandler>
Specifies an event handler for Job.StateChanged events. Use this parameter to build a graphical user interface based on cmdlets. Do not use this parameter in the DPM Management Shell.
Aliases |
Handler |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Tape<Media[]>
Specifies an array of tapes that this cmdlet erases. To obtain a Tape object, use the Get-DPMTape cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Job
Examples
Example 1: Erase the data on a tape
The first command uses the Get-DPMLibrary cmdlet to get the library for the server named Contoso-DPMServer. The command stores the library in the $DpmLibrary variable.
The second command uses the Get-DPMTape cmdlet to get the tapes in the library, and then stores them in the $DpmTape variable.
The third command deletes the data on the third tape object stored in $DpmTape.
PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "Contoso-DPMServer"
PS C:\> $DpmTape = Get-DPMTape -DPMLibrary $DpmLibrary
PS C:\> Start-DPMTapeErase -Tape $DpmTape[2]