powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-ItemProperty



NAME
New-ItemProperty

SYNOPSIS
Creates a new property for an item and sets its value. For example, you can use New-ItemProperty to create and chan
ge registry values and data, which are properties of a registry key.

SYNTAX
New-ItemProperty [-LiteralPath] [-Name] [-Credential ] [-Exclude ] [-Fi
lter ] [-Force] [-Include ] [-PropertyType ] [-Value ] [-Confirm] [-WhatIf] [-Use
Transaction] []

New-ItemProperty [-Path] [-Name] [-Credential ] [-Exclude ] [-Filter tring>] [-Force] [-Include ] [-PropertyType ] [-Value ] [-Confirm] [-WhatIf] [-UseTransac
tion] []


DESCRIPTION
The New-ItemProperty cmdlet creates a new property for a specified item and sets its value. Typically, this cmdlet
is used to create new registry values, because registry values are properties of a registry key item.

This cmdlet does not add properties to an object. To add a property to an instance of an object, use the Add-Member
cmdlet. To add a property to all objects of a particular type, edit the Types.ps1xml file.


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. 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 efficient t
han other parameters, because the provider applies them when retrieving the objects rather than having Windows
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 create a property on an object that cannot otherwise be accessed by the user. Implementati
on varies from provider to provider. For more information, see about_Providers.

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

-Include
The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as "*.txt". Wil
dcards are permitted.

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

-LiteralPath
Specifies a path to the item property. The value of LiteralPath is used exactly as it is typed. No characters a
re interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Sing
le quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.

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

-Name
Specifies a name for the new property. If the property is a registry entry, this parameter specifies the name o
f the entry.

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

-Path
Specifies the path to the item. This parameter identifies the item to which the new property will be added.

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

-PropertyType
Specifies the type of property that will be added.

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

-Value
Specifies the property value. If the property is a registry entry, this parameter specifies the value of the en
try.

Required? false
Position? named
Default value
Accept pipeline input? true (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
None
You cannot pipe input to New-ItemProperty.


OUTPUTS
System.Management.Automation.PSCustomObject
New-ItemProperty returns a custom object that contains the new property.


NOTES


The New-ItemProperty cmdlet is designed to work with the data exposed by any provider. To list the providers av
ailable in your session, type "Get-PSProvider". For more information, see about_Providers.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>new-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 822

C:\PS> get-itemproperty hklm:\software\mycompany


PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 822


Description
-----------
This command adds a new registry entry, NoOfEmployees, to the MyCompany key of the HKLM:\Software hive.

The first command uses the Path parameter to specify the path to the MyCompany registry key. It uses the Name param
eter to specify a name for the entry and the Value parameter to specify its value.

The second command uses the Get-ItemProperty cmdlet to see the new registry entry.





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

C:\PS>get-item -path HKLM:\Software\MyCompany | new-Itemproperty -name NoOfLocations -value 3


Description
-----------
This command adds a new registry entry to a registry key. To specify the key, it uses a pipeline operator (|) to se
nd an object representing the key to the New-ItemProperty cmdlet.

The first part of the command uses the Get-Item cmdlet to get the MyCompany registry key. The pipeline operator (|)
sends the results of the command to the New-ItemProperty cmdlet, which adds the new registry entry, NoOfLocations,
and its value, 3, to the MyCompany key.

This command works because the parameter-binding feature of Windows PowerShell associates the path of the RegistryK
ey object that Get-Item returns with the LiteralPath parameter of New-ItemProperty. For more information, see about
_Pipelines.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113354
about_Providers
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
Rename-ItemProperty
Get-ItemProperty
Set-ItemProperty
Remove-ItemProperty