Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Starts a job to clean a tape drive.
Parameter Set: Default
Start-DPMTapeDriveCleaning [-TapeDrive] <Drive[]> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
The Start-DPMTapeDriveCleaning cmdlet starts a job to clean a tape drive.
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 |
Specifies an array of tape drives. This cmdlet cleans the drives that this parameter specifies.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
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 |
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).
The input type is the type of the objects that you can pipe to the cmdlet.
The output type is the type of the objects that the cmdlet emits.
- Job
The first command uses the Get-DPMLibrary cmdlet to retrieve the library, and then stores it in the $DpmLibrary variable.
The second command uses the Get-DPMTapeDrive cmdlet to retrieve the tape drives in the library, and the stores the result in the $DpmTapeDrive variable.
The third command uses the Start-DPMTapeDriveCleaning cmdlet to clean the tape drive.
PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "Contoso-DPMServer"
PS C:\> $DpmTapeDrive = Get-DPMTapeDrive -DPMLibrary $DPMLibrary
PS C:\> Start-DPMTapeDriveCleaning -TapeDrive $DpmTapeDrive