powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Item



NAME
Set-Item

SYNOPSIS
Changes the value of an item to the value specified in the command.

SYNTAX
Set-Item [-LiteralPath] [[-Value] ] [-Credential ] [-Exclude ] [-Filter
] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []

Set-Item [-Path] [[-Value] ] [-Credential ] [-Exclude ] [-Filter >] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Set-Item cmdlet changes the value of an item, such as a variable or registry key, to the value specified in the
command.


PARAMETERS
-Credential
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, you will be prompted for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Exclude
Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pa
ttern, such as "*.txt". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Filter
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path paramet
er. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficie
nt than other parameters, because the provider applies them when retrieving the objects, rather than having Win
dows PowerShell filter the objects after they are retrieved.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Allows the cmdlet to set items that cannot otherwise be changed, such as read-only alias or variables. The cmdl
et cannot change constant aliases or variables. Implementation varies from provider to provider. For more infor
mation, see about_Providers. Even using the Force parameter, the cmdlet cannot override security restrictions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Include
Changes only the specified items. The value of this parameter qualifies the Path parameter. Enter a path elemen
t or pattern, such as "*.txt". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-LiteralPath
Specifies a path to the location of the new items. Unlike Path, the value of LiteralPath is used exactly as it
is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in sin
gle quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape s
equences.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PassThru []
Passes an object representing the item to the pipeline. By default, this cmdlet does not generate any output.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies a path to the location of the new items. Wildcards are permitted.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Value
Specifies a new value for the item.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-UseTransaction []
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.
For more information, see about_Transactions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Object
You can pipe an object that represents the new value of the item to Set-Item.


OUTPUTS
None or an object representing the new or changed item.
When you use the Passthru parameter, Set-Item generates an object representing the item. Otherwise, this cmdlet
does not generate any output.


NOTES


You can also refer to Set-Item by its built-in alias, "si". For more information, see about_Aliases.

The Set-Item cmdlet is not supported by the Windows PowerShell FileSystem provider. To change the values of ite
ms in the file system, use Set-Content.

In the Registry drives, HKLM: and HKCU:, Set-Item changes the data in the (Default) value of a registry key. To
create and change the names of registry keys, use New-Item and Rename-Item. To change the names and data in re
gistry values, use New-ItemProperty, Set-ItemProperty, and Rename-ItemProperty.

The Set-Item cmdlet 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 --------------------------

C:\PS>set-item -path alias:np -value c:\windows\notepad.exe


Description
-----------
This command creates an alias of "np" for Notepad.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>set-item -path env:UserRole -value Administrator


Description
-----------
This command uses the Set-Item cmdlet to change the value of the "UserRole" environment variable to "Administrator"
.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>set-item -path function:prompt -value {'PS '+ $(Get-Date -format t) + " " + $(Get-Location) + '> '}


Description
-----------
This command uses the Set-Item cmdlet to change the "prompt" function so that it displays the time before the path.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>set-item -path function:prompt -options "AllScope,ReadOnly"


Description
-----------
This command sets the AllScope and ReadOnly options for the "prompt" function. This command uses the Options dynami
c parameter of the Set-Item cmdlet. The Options parameter is available in Set-Item only when you use it with the Al
ias or Function provider.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113395
about_Providers
Get-Item
New-Item
Remove-Item
Clear-Item
Invoke-Item
Rename-Item
Move-Item
Copy-Item