powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-Alias



NAME
New-Alias

SYNOPSIS
Creates a new alias.

SYNTAX
New-Alias [-Name] [-Value] [-Description ] [-Force] [-Option {None | ReadOnly | Constant
| Private | AllScope}] [-PassThru] [-Scope ] [-Confirm] [-WhatIf] []


DESCRIPTION
The New-Alias cmdlet creates a new alias in the current Windows PowerShell session. Aliases created by using New-Al
ias are not saved after you exit the session or close Windows PowerShell. You can use the Export-Alias cmdlet to sa
ve your alias information to a file. You can later use Import-Alias to retrieve that saved alias information.


PARAMETERS
-Description
Specifies a description of the alias. You can type any string. If the description includes spaces, enclose it i
n quotation marks.

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

-Force []
If set, act like set-alias if the alias named already exists.

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

-Name
Specifies the new alias. You can use any alphanumeric characters in an alias, but the first character cannot be
a number.

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

-Option
Sets one or more optional properties of the alias. Valid values are:

-- None: Sets no options. (default)

-- ReadOnly: The alias cannot be changed unless you use the Force parameter.

-- Constant: The alias cannot be changed, even by using the Force parameter.

-- Private: The alias is available only within the scope specified by the Scope parameter. It is invisible in a
ll other scopes.

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

-PassThru []
Returns an object representing the new alias. By default, this cmdlet does not generate any output.

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

-Scope
Specifies the scope of the new alias. Valid values are "Global", "Local", or "Script", or a number relative to
the current scope (0 through the number of scopes, where 0 is the current scope and 1 is its parent). "Local" i
s the default. For more information, see about_Scopes.

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

-Value
Specifies the name of the cmdlet or command element that is being aliased.

Required? true
Position? 2
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


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 this cmdlet.


OUTPUTS
None or System.Management.Automation.AliasInfo
When you use the Passthru parameter, New-Alias generates a System.Management.Automation.AliasInfo object repres
enting the new alias. Otherwise, this cmdlet does not generate any output.


NOTES


To create a new alias, use Set-Alias or New-Alias. To change an alias, use Set-Alias. To delete an alias, use R
emove-Item.


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

C:\PS>new-alias list get-childitem


Description
-----------
This command creates an alias named "list" to represent the Get-ChildItem cmdlet.





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

C:\PS>new-alias -name w -value get-wmiobject -description "quick wmi alias" -option ReadOnly

C:\PS> get-alias -name w | format-list *


Description
-----------
This command creates an alias named "w" to represent the Get-WMIObject cmdlet. It creates a description, "quick wmi
alias", for the alias and makes it read only. The last line of the command uses Get-Alias to get the new alias and
pipes it to Format-List to display all of the information about it.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113352
Set-Alias
Get-Alias
Export-Alias
Import-Alias