Lock-DPMLibraryDoor
Lock-DPMLibraryDoor
Locks the door of a DPM library.
Syntax
Parameter Set: Default
Lock-DPMLibraryDoor [-DPMLibrary] <Library> [-Async] [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Lock-DPMLibraryDoor cmdlet locks 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? |
true (ByPropertyName) |
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 |
Handler |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DPMLibrary<Library>
Specifies a DPM library object that this cmdlet locks. 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, ByPropertyName) |
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.
Examples
Example 1: Lock a library door
The first command gets the libraries associated with the server, and then stores the library objects in the $DpmLibrary variable.
The second command locks the library door for the first library object stored in $DpmLibrary. This DPM server has more than one library. Therefore, the command uses standard Windows PowerShell array syntax to specify the first member of the $DpmLibrary array.
PS C:\> $DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Lock-DPMLibraryDoor -DPMLibrary $DpmLibrary[0]