Remove-DPMTape

Remove-DPMTape

Removes a tape from a DPM library.

Syntax

Parameter Set: Default
Remove-DPMTape [-DPMLibrary] <Library> [-Tape] <Media[]> [-Async] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-DPMTape cmdlet removes a tape from a System Center 2012 – Data Protection Manager (DPM) library.

Parameters

-Async

Indicates that the command runs asynchronously. When you run a command asynchronously, the command prompt returns immediately even if the job takes an extended time to finish.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DPMLibrary<Library>

Specifies a DPM library from which this cmdlet removes a tape. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-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 tape objects that this cmdlet removes. To obtain a Tape object, use the Get-DPMTape cmdlet.

Aliases

none

Required?

true

Position?

2

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 (http://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.

Examples

Example 1: Remove a tape from a library

The first command uses the Get-DPMLibrary cmdlet to retrieve the library for the server. The command stores the result in the $DpmLibrary variable.

The second command uses the Get-Tape cmdlet to retrieve the tape object. The command stores the result in the $DpmTape variable.

The third command uses the Unlock-DPMLibraryDoor cmdlet to unlock the tape door.

The final command removes the third tape from the library.

PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "Contoso-DPMServer"
PS C:\> $DpmTape = Get-DPMTape -DPMLibrary $DpmLibrary
PS C:\> Unlock-DPMLibraryDoor -DPMLibrary $DpmLibrary
PS C:\> Remove-DPMTape -DPMLibrary $DpmLibrary -Tape $DpmTape[2] 

Add-DPMTape

Get-DPMLibrary

Get-DPMTape

Set-DPMTape