Unlock-DPMLibraryDoor
Unlock-DPMLibraryDoor
Unlocks the door of a DPM library.
Syntax
Parameter Set: Default
Unlock-DPMLibraryDoor [-DPMLibrary] <Library> [[-Timeout] <Int32> ] [-Async] [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Unlock-DPMLibraryDoor cmdlet unlocks the door of 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 |
-DoorAccessJobStateChangeEventHandler<DoorAccessJobStateChangeEventHandler>
Specifies an event handler for certain door access events. You can use this parameter to update a GUI that runs in Windows PowerShell, but do not use it in the Windows PowerShell console.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DPMLibrary<Library>
Specifies a DPM library object. 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 |
-Timeout<Int32>
Specifies a time-out period, in seconds, for the unlock action. If the operation times out, the door locks automatically.
Aliases |
none |
Required? |
false |
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 (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.
Notes
- For more information, type "
Get-Help Unlock-DPMLibraryDoor -detailed".
Examples
Example 1: Unlock a library door
This example unlocks a library door for a library associated with the server named DPMServer07. The first command gets a library associated with the server, and stores the library object in the $DPMLib variable.
The second command unlocks the library door for the library object stored in the $DPMLib variable.
PS C:\> $DPMLib = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Unlock-DPMLibraryDoor -DPMLibrary $DPMLib