Set-Alias

Create or change an alias.

Syntax
      Set-Alias [-name] string [-value] string [-description string] 
         [-option ScopedItemOptions]  [-passThru] [-scope string] 
            [-force] [-whatIf] [-confirm] [CommonParameters]
Key
   -name string[]
       The alias to create, the first character cannot be a number.
	   
   -value string
       The name of the cmdlet or command element that is being aliased.
		
   -description string
       A description for the alias.

   -option option
       The valid options are: 
         None    : Set no options. (default) 
         ReadOnly: The alias cannot be changed unless you use -Force. 
         Constant: The alias cannot be changed, even by using -Force. 
         Private : The alias is available only within the scope specified by -Scope. 
                   It is invisible in all other scopes.

   -passThru 
       Pass the object created by this cmdlet through the pipeline. 

    -scope string
        The scope in which this alias is valid. 
        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" is the default.
        For more, type "get-help about_scope".

   -force
       If set, act like set-alias if the alias named already exists.
        
   -whatIf
       Describe what would happen if you executed the command without actually
       executing the command.
       
   -confirm
       Prompt for confirmation before executing the command.

   CommonParameters:
       -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutVariable.

Aliases created with Set-Alias are not saved after you exit the session or close PowerShell. You can use Export-Alias and Import-Alias to save and restore alias information from a file.

Examples

Create an alias named 'list' to represent Get-ChildItem:

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

Create a ReadOnly alias named 'w' to represent Get-WMIObject:

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

Uses Get-Alias to display all the information about the alias called 'List':

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

Associate the alias, "np", with the executable file for Notepad:

PS C:\>Set-Alias np c:\windows\notepad.exe

Create a function that will set location as C:\windows\system32 and then assign the alias "cd32", to the new function:

PS C:\>function func32 {set-location c:\windows\system32}
PS C:\>set-alias cd32 func32 

"When people realize that they do not understand a thing they try to find a name for what they do not 'understand', and when they find a name they
say they 'understand' "- G.I. Gurdjieff

Related:

export-alias epal Export an alias list to a file
import-alias - Import an alias list from a file
get-alias - Return alias names for Cmdlets
new-alias - Create a new Cmdlet-alias pairing
Equivalent bash command: alias - Create an alias



Back to the Top

© Copyright SS64.com 1999-2010
Some rights reserved