Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-Item

New-Item

microsoft.powershell.commands.management.dll

Synopsis

Creates a new item.

Syntax

New-Item [-Path] [-Credential] [-Force] [-ItemType] [-Value] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

New-Item [-Path] [-Credential] [-Force] [-ItemType] [-Value] [-Name] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Detailed Description

The New-Item cmdlet creates a new item and sets its value. The types of items that can be created depend upon the location of the item. For example, in the file system, New-Item is used to create files and folders. In the registry, New-Item creates registry keys and entries.

New-Item can also set the value of the items that it creates. For example, when creating a new file, New-Item can add initial content to the file.

Parameters

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

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

Aliases

None

Required?

false

Position

named

Default value

Current user

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Allows the cmdlet to create an item that writes over an existing read-only item. Implementation varies from provider to provider. For more information, see about_Providers. Even using the Force parameter, the cmdlet cannot override security restrictions.

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-ItemType <String>

Specifies the provider-specified type of the new item. Starting in Windows PowerShell 5.0, you can create symbolic links by specifying SymbolicLink as the value of this parameter.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the new item.

You can specify the name of the new item in the Name or Path parameter value, and you can specify the path to the new item in the Name or Path parameter value.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Path <String[]>

Specifies the path to the location of the new item. Wildcards are permitted.

You can specify the name of the new item in the Name parameter, or include it in the Path parameter.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-Value <Object>

Specifies the value of the new item. You can also pipe a value to New-Item.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

System.Object

Return Type

System.Object

Notes

The New-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.

Examples

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

This command creates a text file named testfile1.txt in the current directory. The dot (.) in the value of the Path parameter indicates the current directory. The quoted text that follows the Value parameter is added to the file as content.

PS C:\>new-item -path . -name testfile1.txt -itemtype "file" -value "This is a text string."

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

This command creates a directory named Logfiles in the C: drive. The ItemType parameter specifies that the new item is a directory, not a file or other file system object.

PS C:\>new-item -path c:\ -name logfiles -itemtype directory

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

This command creates a Windows PowerShell profile in the path that is specified by the $profile variable.

You can use profiles to customize Windows PowerShell. $Profile is an automatic (built-in) variable that stores the path and file name of the CurrentUser/CurrentHost profile. By default, the profile does not exist, even though Windows PowerShell stores a path and file name for it.

In this command, the $profile variable represents the path to the file. The ItemType parameter specifies that the command creates a file. The Force parameter lets you create a file in the profile path, even when the directories in the path do not exist (Windows PowerShell creates them).

After you use this command to create a profile, you can enter aliases, functions, and scripts in the profile to customize your shell.

For more information, see about_Automatic_Variables and about_Profiles.

PS C:\>new-item -path $profile -itemtype file -force

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

This command creates a new Scripts directory in the C:\PS-Test directory.

The name of the new directory item, Scripts, is included in the value of the Path parameter, instead of being specified in the value of the Name parameter. As indicated by the syntax, either command form is valid.

PS C:\>new-item -itemtype directory -path c:\ps-test\scripts

-------------------------- EXAMPLE 5 --------------------------

This command uses the New-Item cmdlet to create files in two different directories. Because the Path parameter takes multiple strings, you can use it to create multiple items.

PS C:\>new-item -itemtype file -path "c:\ps-test\test.txt", "c:\ps-test\Logs\test.log"

Online Version
Clear-Item
Copy-Item
Get-Item
Invoke-Item
Move-Item
Remove-Item
Rename-Item
Set-Item
about_Providers