Share via

Unlock-DPMLibraryDoor

  • Article

Unlock-DPMLibraryDoor

Unlocks the door of the specified library.

Syntax

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

Detailed Description

The Unlock-DPMLibraryDoor cmdlet unlocks the door of the specified library.

Parameters

-Timeout

Indicates when time out should occur.

Attributes

Name Value

Required?

false

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

-DoorAccessJobStateChangeEventHandler

This is the call-back method for an Async door operation. If the user calls the cmdlet with the –Async flag, a static or member method name of a class can be provided to act as the handler for the progress event of the long running door 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

  • If the operation times out, the door locks automatically.

    For more information, type "Get-Help Unlock-DPMLibraryDoor -detailed".
    For technical information, type "Get-Help Unlock-DPMLibraryDoor -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" 
Unlock-DPMLibraryDoor -DPMLibrary $DPMLib