Remove-DPMTape
Removes a tape from a DPM library.
Syntax
Default (Default)
Remove-DPMTape
[-DPMLibrary] <Library>
[-Tape] <Media[]>
[-Async]
[-JobStateChangedEventHandler <JobStateChangedEventHandler>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-DPMTape cmdlet removes a tape from a System Center - Data Protection Manager (DPM) library.
Examples
Example 1: Remove a tape from a 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]
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-DPMTape 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.
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DPMLibrary
Specifies a DPM library from which this cmdlet removes a tape. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.
Parameter properties
| Type: | Library |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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.
Parameter properties
| Type: | JobStateChangedEventHandler |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Handler |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tape
Specifies an array of tape objects that this cmdlet removes. To obtain a Tape object, use the Get-DPMTape cmdlet.
Parameter properties
| Type: | Media[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.