Share via

Unlock-DPMLibraryDoor

Module:
DataProtectionManager Module

Unlocks the door of a DPM library.

Syntax

Default (Default) 

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.

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:False
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:False
Value from remaining arguments:False

-DPMLibrary

Specifies a DPM library object that this cmdlet unlocks. 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:False
Value from remaining arguments:False

-Timeout

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
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.