Share via


Lock-DPMLibraryIEPort

Locks the I/E port for a DPM library and loads the media present in the I/E port.

Syntax

Default (Default)

Lock-DPMLibraryIEPort
    [-DPMLibrary] <Library>
    [-Async]
    [-JobStateChangedEventHandler <JobStateChangedEventHandler>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Lock-DPMLibraryIEPort cmdlet locks the insert/eject (I/E) port for a System Center - Data Protection Manager (DPM) library and loads the media present in the I/E port into the slot.

Examples

Example 1: Lock an I/E port

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

The first command uses the Get-DPMLibrary cmdlet to get the library for the named server, and then stores the library object in the $DpmLibrary variable.

The second command locks the object stored in $DpmLibrary.

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

-DPMLibrary

Specifies a DPM library object for which this cmdlet locks the I/E port. 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

-JobStateChangedEventHandler

Specifies an event handler for Job.StateChanged events. Use this parameter to build a graphical user interface based on cmdlets. Do not use this parameter in the DPM Management Shell.

Parameter properties

Type:JobStateChangedEventHandler
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

-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.