< Back
Set-ItemProperty
Post
NAME Set-ItemProperty
SYNOPSIS
Creates or changes the value of a property of an item.
SYNTAX
Set-ItemProperty [-Path] <String[]> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include
<String[]>] -InputObject <PSObject> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include <String[]>] -InputObject
<PSObject> -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Name] <String> [-Value] <Object> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Path] <String[]> [-Name] <String> [-Value] <Object> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter
<String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ItemProperty cmdlet changes the value of the property of the specified item. You can use the cmdlet to establish or change the properties
of items. For example, you can use Set-ItemProperty to set the value of the IsReadOnly property of a file object to $True.
You also use Set-ItemProperty to create and change registry values and data. For example, you can add a new registry entry to a key and establish
or change its value.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If
you type a user name, this cmdlet prompts you for a password.
This parameter is not supported by any providers installed with parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies those items upon which the cmdlet does not act, and includes all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
Specifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter. The syntax of the
filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the
provider applies them when it retrieves the objects instead of having Windows PowerShell filter the objects after they are retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the cmdlet to set a property on items that cannot otherwise be accessed by the user. Implementation varies from provider to provider.
For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies only those items upon which the cmdlet acts, which excludes all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSObject>
Specifies the object that has the properties that this cmdlet changes. Enter a variable that contains the object or a command that gets the
object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies a path of the item property. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard
characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not
to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object that represents the item property. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies the path of the items with the property to modify.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Value <Object>
Specifies the value of the property.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject
You can pipe objects to this cmdlet.
OUTPUTS
None, System.Management.Automation.PSCustomObject
This cmdlet generates a PSCustomObject object that represents the item that was changed and its new property value, if you specify the
PassThru parameter. Otherwise, this cmdlet does not generate any output.
NOTES
Set-ItemProperty is designed to work with the data exposed by any provider. To list the providers available in your session, type
Get-PSProvider *. For more information, see about_Providers.
*
Example 1: Set a property of a file
PS C:\\>Set-ItemProperty -Path "c:\\GroupFiles\\final.doc" -Name IsReadOnly -Value $True
This command sets the value of the IsReadOnly property of the final.doc file to true.
The command uses Set-ItemProperty to change the value of the property of the final.doc file. It uses Path to specify the file. It uses Name to
specify the name of the property and the Value parameter to specify the new value.
The $True automatic variable represents a value of TRUE. For more information, see about_Automatic_Variables.
The file is a System.IO.FileInfo object and IsReadOnly is just one of its properties. To see all of the properties and methods of a FileInfo
object, pipe the file to the Get-Member cmdlet. For example, type `final.doc | Get-Member`.
Example 2: Create a registry entry and value
PS C:\\>Set-ItemProperty -Path "HKLM:\\Software\\ContosoCompany" -Name "NoOfEmployees" -Value 823
PS C:\\> Get-ItemProperty -Path "HKLM:\\Software\\MyCompany"
PSPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software\\contosocompany
PSParentPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software
PSChildName : contosocompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\\Registry
NoOfLocations : 2
NoOfEmployees : 823
PS C:\\> Set-ItemProperty -Path "HKLM:\\Software\\ContosoCompany" -Name "NoOfEmployees" -value 824
PS C:\\> Get-ItemProperty -Path "HKLM:\\Software\\ContosoCompany"
PSPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software\\contosocompany
PSParentPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software
PSChildName : contosocompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\\Registry
NoOfLocations : 2
NoOfEmployees : 824
This example shows how to use Set-ItemProperty to create a new registry entry and to assign a value to the entry. It creates the NoOfEmployees
entry in the ContosoCompany key in HKLM\\Software key and sets its value to 823.
Because registry entries are considered to be properties of the registry keys, which are items, you use Set-ItemProperty to create registry
entries, and to establish and change their values.
The first command creates the registry entry. It uses Path to specify the path of the HKLM: drive and the Software\\MyCompany key. The command uses
Name to specify the entry name and Value to specify a value.
The second command uses the Get-ItemProperty cmdlet to see the new registry entry. If you use the Get-Item or Get-ChildItem cmdlets, the entries
do not appear because they are properties of a key, not items or child items.
The third command changes the value of the NoOfEmployees entry to 824.
You can also use the New-ItemProperty cmdlet to create the registry entry and its value and then use Set-ItemProperty to change the value.
For more information about the HKLM: drive, type `Get-Help Get-PSDrive`. For more information about how to use Windows PowerShell to manage the
registry, type `Get-Help Registry`.
Example 3: Modify an item by using the pipeline
PS C:\\>Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True
These commands show how to use a pipeline operator (|) to send an item to Set-ItemProperty .
The first part of the command uses Get-ChildItem to get an object that represents the Weekly.txt file. The command uses a pipeline operator to
send the file object to Set-ItemProperty . The Set-ItemProperty command uses the Name and Value parameters to specify the property and its new
value.
This command is equivalent to using the InputObject parameter to specify the object that Get-ChildItem gets.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821631
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty
SYNOPSIS
Creates or changes the value of a property of an item.
SYNTAX
Set-ItemProperty [-Path] <String[]> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include
<String[]>] -InputObject <PSObject> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include <String[]>] -InputObject
<PSObject> -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Name] <String> [-Value] <Object> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Set-ItemProperty [-Path] <String[]> [-Name] <String> [-Value] <Object> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter
<String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ItemProperty cmdlet changes the value of the property of the specified item. You can use the cmdlet to establish or change the properties
of items. For example, you can use Set-ItemProperty to set the value of the IsReadOnly property of a file object to $True.
You also use Set-ItemProperty to create and change registry values and data. For example, you can add a new registry entry to a key and establish
or change its value.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If
you type a user name, this cmdlet prompts you for a password.
This parameter is not supported by any providers installed with parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies those items upon which the cmdlet does not act, and includes all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
Specifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter. The syntax of the
filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the
provider applies them when it retrieves the objects instead of having Windows PowerShell filter the objects after they are retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the cmdlet to set a property on items that cannot otherwise be accessed by the user. Implementation varies from provider to provider.
For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies only those items upon which the cmdlet acts, which excludes all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSObject>
Specifies the object that has the properties that this cmdlet changes. Enter a variable that contains the object or a command that gets the
object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies a path of the item property. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcard
characters. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not
to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object that represents the item property. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies the path of the items with the property to modify.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Value <Object>
Specifies the value of the property.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject
You can pipe objects to this cmdlet.
OUTPUTS
None, System.Management.Automation.PSCustomObject
This cmdlet generates a PSCustomObject object that represents the item that was changed and its new property value, if you specify the
PassThru parameter. Otherwise, this cmdlet does not generate any output.
NOTES
Set-ItemProperty is designed to work with the data exposed by any provider. To list the providers available in your session, type
Get-PSProvider *. For more information, see about_Providers.
*
Example 1: Set a property of a file
PS C:\\>Set-ItemProperty -Path "c:\\GroupFiles\\final.doc" -Name IsReadOnly -Value $True
This command sets the value of the IsReadOnly property of the final.doc file to true.
The command uses Set-ItemProperty to change the value of the property of the final.doc file. It uses Path to specify the file. It uses Name to
specify the name of the property and the Value parameter to specify the new value.
The $True automatic variable represents a value of TRUE. For more information, see about_Automatic_Variables.
The file is a System.IO.FileInfo object and IsReadOnly is just one of its properties. To see all of the properties and methods of a FileInfo
object, pipe the file to the Get-Member cmdlet. For example, type `final.doc | Get-Member`.
Example 2: Create a registry entry and value
PS C:\\>Set-ItemProperty -Path "HKLM:\\Software\\ContosoCompany" -Name "NoOfEmployees" -Value 823
PS C:\\> Get-ItemProperty -Path "HKLM:\\Software\\MyCompany"
PSPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software\\contosocompany
PSParentPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software
PSChildName : contosocompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\\Registry
NoOfLocations : 2
NoOfEmployees : 823
PS C:\\> Set-ItemProperty -Path "HKLM:\\Software\\ContosoCompany" -Name "NoOfEmployees" -value 824
PS C:\\> Get-ItemProperty -Path "HKLM:\\Software\\ContosoCompany"
PSPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software\\contosocompany
PSParentPath : Microsoft.PowerShell.Core\\Registry::HKEY_LOCAL_MACHINE\\software
PSChildName : contosocompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\\Registry
NoOfLocations : 2
NoOfEmployees : 824
This example shows how to use Set-ItemProperty to create a new registry entry and to assign a value to the entry. It creates the NoOfEmployees
entry in the ContosoCompany key in HKLM\\Software key and sets its value to 823.
Because registry entries are considered to be properties of the registry keys, which are items, you use Set-ItemProperty to create registry
entries, and to establish and change their values.
The first command creates the registry entry. It uses Path to specify the path of the HKLM: drive and the Software\\MyCompany key. The command uses
Name to specify the entry name and Value to specify a value.
The second command uses the Get-ItemProperty cmdlet to see the new registry entry. If you use the Get-Item or Get-ChildItem cmdlets, the entries
do not appear because they are properties of a key, not items or child items.
The third command changes the value of the NoOfEmployees entry to 824.
You can also use the New-ItemProperty cmdlet to create the registry entry and its value and then use Set-ItemProperty to change the value.
For more information about the HKLM: drive, type `Get-Help Get-PSDrive`. For more information about how to use Windows PowerShell to manage the
registry, type `Get-Help Registry`.
Example 3: Modify an item by using the pipeline
PS C:\\>Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True
These commands show how to use a pipeline operator (|) to send an item to Set-ItemProperty .
The first part of the command uses Get-ChildItem to get an object that represents the Weekly.txt file. The command uses a pipeline operator to
send the file object to Set-ItemProperty . The Set-ItemProperty command uses the Name and Value parameters to specify the property and its new
value.
This command is equivalent to using the InputObject parameter to specify the object that Get-ChildItem gets.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821631
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty