Start-TapeErase
Start-TapeErase
Starts a tape erase job.
Syntax
Start-TapeErase [-Tape] <Media> [-JobStateChangedEventHandler <JobStateChangedEventHandler>] [<CommonParameters>]
Detailed Description
The Start-TapeErase cmdlet starts a tape erase job.
Parameters
-Tape
Indicates a tape object.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue) |
Position? |
0 |
-JobStateChangedEventHandler
The JobStateChangedEventHandler is used along with the -Async parameter so that the user can be informed of the status of the operation. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Notes
For more information, type "Get-Help Start-TapeErase -detailed".
For technical information, type "Get-Help Start-TapeErase -full".Additionally, any updated information about the cmdlet will be available at https://go.microsoft.com/fwlink/?LinkId=95130.
Examples
EXAMPLE 1
$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"
$Tape = Get-Tape -DPMLibrary $DPMLib
Start-TapeErase -Tape $Tape[2]
This command erases the contents on the specified tape.