- Reference
- Module:
- Microsoft.PowerShell.Management
Creates or changes the value of a property of an item.
Syntax
Set-ItemProperty [-Path] <string[]> [-Name] <string> [-Value] <Object> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [<CommonParameters>] Set-ItemProperty [-Path] <string[]> -InputObject <psobject> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [<CommonParameters>] Set-ItemProperty [-Name] <string> [-Value] <Object> -LiteralPath <string[]> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [<CommonParameters>] Set-ItemProperty -LiteralPath <string[]> -InputObject <psobject> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [<CommonParameters>] Set-ItemProperty [-Path] <string[]> [-Name] <string> [-Value] <Object> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [-Type <RegistryValueKind>] [<CommonParameters>] Set-ItemProperty [-Path] <string[]> -InputObject <psobject> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [-Type <RegistryValueKind>] [<CommonParameters>] Set-ItemProperty [-Name] <string> [-Value] <Object> -LiteralPath <string[]> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [-Type <RegistryValueKind>] [<CommonParameters>] Set-ItemProperty -LiteralPath <string[]> -InputObject <psobject> [-PassThru] [-Force] [-Filter <string>] [-Include <string[]>] [-Exclude <string[]>] [-Credential <pscredential>] [-WhatIf] [-Confirm] [-Type <RegistryValueKind>] [<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 afile 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.
Examples
Example 1: Set a property of a file
This command sets the value of the IsReadOnly property of the "final.doc" file to "true".It uses Path to specify the file, Name to specify the name of the property, and theValue parameter to specify the new value.
The file is a System.IO.FileInfo object and IsReadOnly is just one of its properties.To see all of the properties, type Get-Item C:\GroupFiles\final.doc | Get-Member -MemberType Property.
The $true automatic variable represents a value of "TRUE". For more information, seeabout_Automatic_Variables.
Set-ItemProperty -Path C:\GroupFiles\final.doc -Name IsReadOnly -Value $trueExample 2: Create a registry entry and value
This example shows how to use Set-ItemProperty to create a new registry entry and to assign avalue to the entry. It creates the "NoOfEmployees" entry in the "ContosoCompany" key inHKLM\Software key and sets its value to 823.
Because registry entries are considered to be properties of the registry keys, which are items, youuse Set-ItemProperty to create registry entries, and to establish and change their values.
Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 823Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompanyPSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\softwarePSChildName : contosocompanyPSDrive : HKLMPSProvider : Microsoft.PowerShell.Core\RegistryNoOfLocations : 2NoOfEmployees : 823Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 824Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompanyPSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\softwarePSChildName : contosocompanyPSDrive : HKLMPSProvider : Microsoft.PowerShell.Core\RegistryNoOfLocations : 2NoOfEmployees : 824The 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 areproperties 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 thenuse 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 PowerShell to manage the registry, type Get-Help Registry.
Example 3: Modify an item by using the pipeline
Th example uses Get-ChildItem to get the weekly.txt file. The file object is piped toSet-ItemProperty. The Set-ItemProperty command uses the Name and Value parameters tospecify the property and its new value.
Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $TrueParameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Note
This parameter is not supported by any providers installed with PowerShell.To impersonate another user, or elevate your credentials when running this cmdlet,use Invoke-Command.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Exclude
Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The valueof this parameter qualifies the Path parameter. Enter a path element or pattern, such as*.txt. Wildcard characters are permitted. The Exclude parameter is effective only when thecommand includes the contents of an item, such as C:\Windows\*, where the wildcard characterspecifies the contents of the C:\Windows directory.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Filter
Specifies a filter to qualify the Path parameter. TheFileSystem provider is the onlyinstalled PowerShell provider that supports the use of filters. You can find the syntax for theFileSystem filter language inabout_Wildcards. Filters are more efficientthan other parameters, because the provider applies them when the cmdlet gets the objects ratherthan having PowerShell filter the objects after they are retrieved.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Force
Forces the cmdlet to set a property on items that cannot otherwise be accessed by the user.Implementation varies by provider. For more information, seeabout_Providers.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Include
Specifies, as a string array, an item or items that this cmdlet includes in the operation. The valueof this parameter qualifies the Path parameter. Enter a path element or pattern, such as"*.txt". Wildcard characters are permitted. The Include parameter is effective only when thecommand includes the contents of an item, such as C:\Windows\*, where the wildcard characterspecifies the contents of the C:\Windows directory.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-InputObject
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.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
Specifies a path to one or more locations. The value of LiteralPath is used exactly as it istyped. No characters are interpreted as wildcards. If the path includes escape characters, encloseit in single quotation marks. Single quotation marks tell PowerShell not to interpret any charactersas escape sequences.
For more information, seeabout_Quoting_Rules.
| Type: | String[] |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the property.
| Type: | String |
| Aliases: | PSProperty |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object that represents the item property.By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Specifies the path of the items with the property to modify.Wildcard characters are permitted.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Type
This is a dynamic parameter made available by the Registry provider. The Registry providerand this parameter are only available on Windows.
Specifies the type of property that this cmdlet adds. The acceptable values for this parameter are:
String: Specifies a null-terminated string. Used for REG_SZ values.ExpandString: Specifies a null-terminated string that contains unexpanded references toenvironment variables that are expanded when the value is retrieved. Used for REG_EXPAND_SZvalues.Binary: Specifies binary data in any form. Used for REG_BINARY values.DWord: Specifies a 32-bit binary number. Used for REG_DWORD values.MultiString: Specifies an array of null-terminated strings terminated by two null characters.Used for REG_MULTI_SZ values.Qword: Specifies a 64-bit binary number. Used for REG_QWORD values.Unknown: Indicates an unsupported registry data type, such as REG_RESOURCE_LIST values.
| Type: | RegistryValueKind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Value
Specifies the value of the property.
| Type: | Object |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs.The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
PSObject
You can pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
PSCustomObject
When you use the PassThru parameter, this cmdlet returns a PSCustomObject objectrepresenting the item that was changed and its new property value.
Notes
PowerShell includes the following aliases for Set-ItemProperty:
- All platforms:
sp
Set-ItemProperty is designed to work with the data exposed by any provider. To list the providersavailable in your session, type Get-PSProvider. For more information, seeabout_Providers.
- Clear-ItemProperty
- Copy-ItemProperty
- Get-ItemProperty
- Move-ItemProperty
- New-ItemProperty
- Remove-ItemProperty
- Rename-ItemProperty
- about_Providers
