Start-DPMTapeDriveCleaning

Start-DPMTapeDriveCleaning

Starts a job to clean a tape drive.

Syntax

Parameter Set: Default
Start-DPMTapeDriveCleaning [-TapeDrive] <Drive[]> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Start-DPMTapeDriveCleaning cmdlet starts a job to clean a tape drive.

Parameters

-JobStateChangedEventHandler<JobStateChangedEventHandler>

Indicates that the cmdlet displays the status of the operation to the user.

-TapeDrive<Drive[]>

Specifies an array of tape drives.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<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

Notes

• For more information, type "Get-Help Start-DPMTapeDriveCleaning -detailed".

Examples

Example 1: Clean a tape drive

This example performs a tape drive cleaning operation.

The first command uses the Get-DPMLibrary cmdlet to retrieve the library, and stores the result in the variable named $DPMLib.

The second command uses the Get-TapeDrive cmdlet to retrieve the list of the tape drives in the library, and stores the result in the variable named $TDrive.

The third command uses the Start-DPMTapeDriveCleaning cmdlet to clean the tape drive.

PS C:\> $DPMLib = Get-DPMLibrary -DPMServerName "Contoso-DPMServer"
PS C:\> $TDrive = Get-TapeDrive -DPMLibrary $DPMLib
PS C:\> Start-DPMTapeDriveCleaning -TapeDrive $TDrive

Related topics

Get-DPMLibrary