Remove-Tape
Remove-Tape
Removes a tape from a DPM library.
Syntax
Remove-Tape [-Tape] <Media> [-DPMLibrary] <Library> [-Async <SwitchParameter>] [-Confirm] [-JobStateChangedEventHandler <JobStateChangedEventHandler>] [<CommonParameters>]
Detailed Description
The Remove-Tape cmdlet removes a tape from a DPM library.
Parameters
-Tape
Indicates a tape object.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue) |
Position? |
1 |
-DPMLibrary
A DPM library object.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue) |
Position? |
0 |
-Async
Allows the user to indicate that the cmdlet should run asynchronously. This is useful with cmdlets that take a long time to complete. The control returns to the user immediately after the operation starts. The progress of the operation is communicated to the user periodically. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Confirm
Asks the user to confirm the action.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-JobStateChangedEventHandler
The JobStateChangedEventHandler is used along with the -Async parameter so that the user can be informed of the status of the operation. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Notes
For more information, type "Get-Help Remove-Tape -detailed".
For technical information, type "Get-Help Remove -Tape -full".Additionally, any updated information about the cmdlet will be available at https://go.microsoft.com/fwlink/?LinkId=95130.
Examples
EXAMPLE 1
$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"
$Tape = Get-Tape -DPMLibrary $DPMLib
Unlock-DPMLibraryDoor -DPMLibrary $DPMLib
Remove-Tape -DPMLibrary $DPMLib -Tape $Tape[2]
This command removes a tape from the library.