powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-Alias



NAME
Get-Alias

SYNOPSIS
Gets the aliases for the current session.

SYNTAX
Get-Alias [[-Name] ] [-Exclude ] [-Scope ] []

Get-Alias [-Definition ] [-Exclude ] [-Scope ] []


DESCRIPTION
The Get-Alias cmdlet gets the aliases (alternate names for commands and executable files) in the current session. T
his includes built-in aliases, aliases that you have set or imported, and aliases that you have added to your Windo
ws PowerShell profile.

By default, Get-Alias takes an alias and returns the command name. When you use the Definition parameter, Get-Alias
takes a command name and returns its aliases.


PARAMETERS
-Definition
Gets the aliases for the specified item. Enter the name of a cmdlet, function, script, file, or executable file
.

This parameter is called Definition, because it searches for the item name in the Definition property of the al
ias object.

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

-Exclude
Omits the specified items. The value of this parameter qualifies the Name and Definition parameters. Enter a na
me, a definition, or a pattern, such as "s*". Wildcards are permitted.

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

-Name
Specifies the aliases to retrieve. Wildcards are permitted. By default, Get-Alias retrieves all aliases defined
for the current session. The parameter name ("Name") is optional. You can also pipe alias names to Get-Alias.

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

-Scope
Gets only the aliases in the specified scope. Valid values are "Global", "Local", or "Script", or a number rela
tive 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 information, see about_Scopes.

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.String
You can pipe alias names to Get-Alias.


OUTPUTS
System.Management.Automation.AliasInfo
Get-Alias returns an object that represents each alias.


NOTES


An alias is an alternate name or nickname for a cmdlet, function, or an executable file. To run the cmdlet, fun
ction, or executable, you can use its full name or any alias. For more information, see about_Aliases.

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


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

C:\PS>get-alias


Description
-----------
This command gets all aliases in the current session.





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

C:\PS>get-alias -name g*, s* -exclude get-*


Description
-----------
This command gets all aliases that begin with "g" or "s", except for aliases that begin with "get-".





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

C:\PS>get-alias -definition Get-ChildItem


Description
-----------
This command gets the aliases for the Get-ChildItem cmdlet.

By default, the Get-Alias cmdlet gets the item name when you know the alias. The Definition parameter gets the alia
s when you know the item name.





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

C:\PS>get-alias | where-object {$_.Options -match "ReadOnly"}


Description
-----------
This command retrieves all aliases in which the value of the Options property is ReadOnly. This command provides a
quick way to find the aliases that are built into Windows PowerShell, because they have the ReadOnly option.

Options is just one property of the AliasInfo objects that Get-Alias gets. To find all properties and methods of Al
iasInfo objects, type "get-alias | get-member".





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

C:\PS>get-alias -definition "*-pssession" -exclude e* -scope global


Description
-----------
This example gets aliases for commands that have names that end in "-pssession", except for those that begin with "
e".

The command uses the Scope parameter to apply the command in the global scope. This is useful in scripts when you w
ant to get the aliases in the session.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113306
about_Aliases
Set-Alias
New-Alias
Export-Alias
Import-Alias
Alias Provider