Lock-DPMLibraryDoor
Locks the door of a DPM library.
Syntax
Default (Default)
Lock-DPMLibraryDoor
[-DPMLibrary] <Library>
[-Async]
[-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Lock-DPMLibraryDoor cmdlet locks the door of a System Center - Data Protection Manager (DPM) library.
Examples
Example 1: Lock a library door
PS C:\>$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Lock-DPMLibraryDoor -DPMLibrary $DpmLibrary[0]
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.
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: | True |
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 |
-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.
Parameter properties
Type: | DoorAccessJobStateChangeEventHandler |
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: | True |
Value from remaining arguments: | False |
-DPMLibrary
Specifies a DPM library object that this cmdlet locks. 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: | True |
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.