powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Import-Alias



NAME
Import-Alias

SYNOPSIS
Imports an alias list from a file.

SYNTAX
Import-Alias [-Path] [-Force] [-PassThru] [-Scope ] [-Confirm] [-WhatIf] []


DESCRIPTION
The Import-Alias cmdlet imports an alias list from a file.


PARAMETERS
-Force []
Allows the cmdlet to import an alias that is already defined and is read only. You can use the following comman
d to display information about the currently-defined aliases:

get-alias | select-object name,Options
The value of the Options property will include "ReadOnly" if the corresponding alias is read only.

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

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

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

-Path
Specifies the path to a file that includes exported alias information. Wildcards are allowed but they must reso
lve to a single name.

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

-Scope
Specifies the scope into which the aliases are imported. 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 information, see about_Scopes.

Required? false
Position? named
Default value
Accept pipeline input? false
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
System.String
You can pipe a string that contains a path to Import-Alias.


OUTPUTS
None or System.Management.Automation.AliasInfo
When you use the Passthru parameter, Import-Alias returns a System.Management.Automation.AliasInfo object that
represents the alias. Otherwise, this cmdlet does not generate any output.


NOTES





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

C:\PS>import-alias test.txt


Description
-----------
This command imports alias information from a file named test.txt.






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