Share via

Unlock-DPMLibraryDoor

  • Reference
Module:
DataProtectionManager

Unlocks the door of a DPM library.

Syntax

Unlock-DPMLibraryDoor
      [-DPMLibrary] <Library>
      [[-Timeout] <Int32>]
      [-Async]
      [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Unlock-DPMLibraryDoor cmdlet unlocks the door of a System Center - Data Protection Manager (DPM) library.

Examples

Example 1: Unlock a library door

PS C:\>$DpmLibrary = Get-DPMLibrary -DPMServerName "DPMServer07"
PS C:\> Unlock-DPMLibraryDoor -DPMLibrary $DpmLibrary

The first command gets a library associated with the server, and then stores the library object in the $DpmLibrary variable.

The second command unlocks the library door for the library object stored in the $DpmLibrary variable.

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:DoorAccessJobStateChangeEventHandler
Aliases:Handler
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DPMLibrary

Specifies a DPM library object that this cmdlet unlocks. To obtain a DPM library object, use the Get-DPMLibrary cmdlet.

Type:Library
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

Specifies a time-out period, in seconds, for the unlock action. If the operation times out, the door locks automatically.

Type:Int32
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False