| external help file | Module Name | online version | schema |
|---|---|---|---|
ResourceLocker-help.xml |
ResourceLocker |
2.0.0 |
Unlocks a resource/host.
Unlock-Resource [-LockObject] <FileInfo[]> [[-HistoryFolderName] <String>] [[-FileNameTemplate] <String>]
[<CommonParameters>]
THe function allow you to gracefully unlock a network resource. The main purpose of such unlock is to maintain history of locks: it's implemented by utilizing a history folder on each host where disengaged lock files are moved. When the function disengages a lock file, it writes the current time in it so you can keep track of locks on a host.
PS C:\> $Lock | Unlock-ResourceUnlocks a resource based on a lock object passed through the pipeline.
PS C:\> Unlock-Resource -LockObject $Lock
Unlocks a resource based on a lock object passed directly into the parameter.The lock object you would like to disengage.
Type: FileInfo[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the name of a folder where to put a disengaged lock.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: $ModuleWideLockHistoryFolderName
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the template which is used to distinguish lock files.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: $ModuleWideLockFileNameTemplate
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).