Lock-Item
Locks the Sitecore item by the current or specified user.
Syntax
Lock-Item [-Item] <Item> [-Force] [-PassThru] [-Identity <AccountIdentity>]
Lock-Item [-Path] <String> [-Force] [-PassThru] [-Identity <AccountIdentity>]
Lock-Item -Id <String> [-Database <String>] [-Force] [-PassThru] [-Identity <AccountIdentity>]
Detailed Description
The Lock-Item command unlocks the item.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Parameters
-Force <SwitchParameter>
Forces the item to be locked by the specified user even if it's currently locked by another user.
Aliases
​
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-PassThru <SwitchParameter>
Passes the processed object back into the pipeline.
Aliases
​
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Identity <AccountIdentity>
User name including domain for which the item is to be locked. If no domain is specified - 'sitecore' will be used as the default domain.
Specifies the Sitecore user by providing one of the following values.
1
Local Name
2
Example: adam
3
Fully Qualified Name
4
Example: sitecore\adam
Copied!
Aliases
​
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Item <Item>
The item to be processed.
Aliases
​
Required?
true
Position?
1
Default Value
​
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false
-Path <String>
Path to the item to be processed - can work with Language parameter to specify the language other than current session language.
Aliases
​
Required?
true
Position?
1
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Id <String>
Id of the item to be processed.
Aliases
​
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Database <String>
Database containing the item to be fetched with Id parameter.
Aliases
​
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- can be piped from another cmdlet* Sitecore.Data.Items.Item
Outputs
The output type is the type of the objects that the cmdlet emits.
- Only if -PassThru is used* Sitecore.Data.Items.Item
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE 1
Lock the Home item providing its path
1
PS master:\> Lock-Item -Path master:\content\home
Copied!
EXAMPLE 2
Lock the Home item by providing it from the pipeline and passing it back to the pipeline. The Item is locked by the "sitecore\adam" user.
1
PS master:\> Get-Item -Path master:\content\home | Lock-Item -PassThru -Identity sitecore\adam
2
​
3
Name Children Languages Id TemplateName
4
---- -------- --------- -- ------------
5
Home False {en, ja-JP, de-DE, da} {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
Copied!
Related Topics
- Get-Item
Last modified 2yr ago