Start-DPMTapeErase
Updated: January 14, 2013
Applies To: System Center 2012 - Data Protection Manager
Start-DPMTapeErase
Syntax
Parameter Set: Default Start-DPMTapeErase [-Tape] <Media[]> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Start-DPMTapeErase cmdlet starts a tape erase job.
Parameters
-JobStateChangedEventHandler<JobStateChangedEventHandler>
Indicates that the status of the operation should be displayed to the user. The JobStateChangedEventHandler is used along with the -Async parameter. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Tape<Media[]>
Indicates a tape object.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
false |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
|
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.
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
Notes
-
For more information, type "Get-Help Start-DPMTapeErase -detailed".
For technical information, type "Get-Help Start-DPMTapeErase -full".
Examples
EXAMPLE 1
This command erases the contents on the specified tape.
PS C:\>$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"$Tape = Get-Tape -DPMLibrary $DPMLibStart-DPMTapeErase -Tape $Tape[2]
