NAME
Import-Module
SYNOPSIS
Adds modules to the current session.
SYNTAX
Import-Module [-Name] <string[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]
Import-Module [-Assembly] <Assembly[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]
Import-Module [-ModuleInfo] <PSModuleInfo[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]
DESCRIPTION
The Import-Module cmdlet adds one or more modules to the current session.
A module is a package that contains members (such as cmdlets, providers, scripts, Functions, Variables, and other tools and files) that can be used in Windows PowerShell. After a module is imported, you can use the module members in your session.
To import a module, use the Name, Assembly, or ModuleInfo parameter to identify the module to import. By default, Import-Module imports all members that the module exports, but you can use the Alias, Function, Cmdlet, and Variable parameters to restrict the members that are imported.
Import-Module imports a module only into the current session. To import the module into all sessions, add an Import-Module command to your Windows PowerShell profile. For more information about profiles, see about_profiles.
For more information about modules, see about_modules.
PARAMETERS
-Alias <string[]>
Imports only the specified Aliases from the module into the current session. Enter a comma-separated list of Aliases. Wildcard characters are permitted.
Some modules automatically export selected Aliases into your session when you import the module. This parameter lets you select from among the exported Aliases.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-ArgumentList <Object[]>
Specifies arguments (parameter values) that are passed to a script module during the Import-Module command. This parameter is valid only when you are importing a script module.
You can also refer to ArgumentList by its Alias, “args”. For more information, see about_aliases.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AsCustomObject [<SwitchParameter>]
Returns a custom object with members that represent the imported module members. This parameter is valid only for script modules.
When you use the AsCustomObject parameter, Import-Module imports the module members into the session and then returns a PSCustomObject object instead of a PSModuleInfo object. You can save the custom object in a Variable and use dot notation to invoke the members.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Assembly <Assembly[]>
Imports the cmdlets and providers implemented in the specified assembly objects. Enter a Variable that contains assembly objects or a command that creates assembly objects. You can also pipe an assembly object to Import-Module.
When you use this parameter, only the cmdlets and providers implemented by the specified assemblies are imported. If the module contains other files, they are not imported, and you might be missing important members of the module. Use this parameter for debugging and testing the module, or when you are instructed to use it by the module author.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Cmdlet <string[]>
Imports only the specified cmdlets from the module into the current session. Enter a list of cmdlets. Wildcard characters are permitted.
Some modules automatically export selected cmdlets into your session when you import the module. This parameter lets you select from among the exported cmdlets.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-Force [<SwitchParameter>]
Re-imports a module and its members, even if the module or its members have an access mode of read-only.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Function <string[]>
Imports only the specified Functions from the module into the current session. Enter a list of Functions. Wildcard characters are permitted.
Some modules automatically export selected Functions into your session when you import the module. This parameter lets you select from among the exported Functions.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-Global [<SwitchParameter>]
When used in a script module (.psm1), this parameter imports modules into the global session state.
This parameter is effective only when it appears in a script module. Otherwise, it is ignored.
By default, the commands in a script module, including commands from nested modules, are imported into the caller’s session state. To restrict the commands that a module exports, use an Export-ModuleMember command in the script module.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ModuleInfo <PSModuleInfo[]>
Specifies module objects to import. Enter a Variable that contains the module objects, or a command that gets the module objects, such as a “Get-Module -listavailable” command. You can also pipe module objects to Import-Module.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <string[]>
Specifies the names of the modules to import. Enter the name of the module or the name of a file in the module, such as a .psd1, .psm1, .dll, or ps1 file. File paths are optional. Wildcards are not permitted. You can also pipe module names and file names to Import-Module.
If you omit a path, Import-Module looks for the module in the paths saved in the PSModulePath Environment Variable ($env:PSModulePath).
Specify only the module name whenever possible. When you specify a file name, only the members that are implemented in that file are imported. If the module contains other files, they are not imported, and you might be missing important members of the module.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns objects that represent the modules that were imported. By default, this cmdlet does not generate any output.
Notes
— When you pipe the output of a “Get-Module -listavailable” command to an Import-Module command with the PassThru parameter, Import-Module returns the object that Get-Module passed to it without updating the object. As a result, the Exported and NestedModules properties are not yet populated.
— When you use the Prefix parameter to specify a prefix for the member, the prefix does not appear in the member names in the properties of the module object. The object records what was exported before the prefix was applied.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Prefix <string>
Adds the specified prefix to the nouns in the names of imported module members.
Use this parameter to avoid name conflicts that might occur when different members in the session have the same name. This parameter does not change the module, and it does not affect files that the module imports for its own use (known as “nested modules”). It affects only the names of members in the current session.
For example, if you specify the prefix “UTC” and then import a Get-Date cmdlet, the cmdlet is known in the session as Get-UTCDate, and it is not confused with the original Get-Date cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Variable <string[]>
Imports only the specified Variables from the module into the current session. Enter a list of Variables. Wildcard characters are permitted.
Some modules automatically export selected Variables into your session when you import the module. This parameter lets you select from among the exported Variables.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-Version <Version>
Specifies the version of the module to import. Use this parameter when you have different versions of the same module on your system.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
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, System.Management.Automation.PSModuleInfo, System.Reflection.Assembly
You can pipe a module name, module object, or assembly object to Import-Module.
OUTPUTS
None, System.Management.Automation.PSModuleInfo, or System.Management.Automation.PSCustomObject
By default, Import-Module does not generate any output. If you use the PassThru parameter, it generates a System.Management.Automation.PSModuleInfo object that represents the module. If you use the AsCustomObject parameter, it generates a PSCustomObject object.
NOTES
You can also refer to Import-Module by its Alias, “ipmo”. For more information, see about_aliases.
Before you can import a module, the module directory must be copied to a directory that is accessible to your local computer. For more information, see about_modules.
Module members run in their own private module session state, so the commands that they use for internal processing do not affect your session state.
If you import members with the same name and the same type into your session, Windows PowerShell uses the member imported last by default. Variables and Aliases are replaced, and the originals are not accessible. Functions, cmdlets and providers are merely “shadowed” by the new members, and they can be accessed by qualifying the command name with the name of its snap-in, module, or Function path.
To update the formatting data for commands that have been imported from a module, use the Update-FormatData cmdlet. Update-FormatData also updates the formatting data for commands in the session that were imported from modules. If the formatting file for a module changes, you can run an Update-FormatData command to update the formatting data for imported commands. You do not need to import the module again.
To import a module that is created by Import-PSSession or Export-PSSession, the execution policy in the current session cannot be Restricted or AllSigned, because the modules that Import-PSSession and Export-PSSession create contains unsigned script files that are prohibited by these policies. To use Import-Module without changing the execution policy for the local computer, use the Scope parameter of Set-ExecutionPolicy to set a less restrictive execution policy for a single process.
————————– EXAMPLE 1 ————————–
C:\PS>Import-Module -Name BitsTransfer
Description
———–
This command imports the members of the BitsTransfer module into the current session.
The Name parameter name (-Name) is optional and can be omitted.
By default, Import-Module does not generate any output when it imports a module. To request output, use the PassThru or AsCustomObject parameter, or the Verbose common parameter.
————————– EXAMPLE 2 ————————–
C:\PS>Get-Module -listAvailable | Import-Module
Description
———–
This command imports all available modules in the path specified by the PSModulePath Environment Variable ($env:psmodulepath) into the current session.
————————– EXAMPLE 3 ————————–
C:\PS>$m = Get-Module -ListAvailable BitsTransfer, ServerBackup
C:\PS> Import-Module -moduleInfo $m
Description
———–
These commands import the members of the BitsTransfer and ServerBackup modules into the current session.
The first command uses the Get-Module cmdlet to get PSModuleInfo objects that represent the BitsTransfer and ServerBackup modules. It saves the objects in the $m Variable. The ListAvailable parameter is required when you are getting modules that are not yet imported into the session.
The second command uses the ModuleInfo parameter of Import-Module to import the modules into the current session.
These commands are equivalent to using a pipeline operator (|) to send the output of a Get-Module command to Import-Module.
————————– EXAMPLE 4 ————————–
C:\PS>Import-Module -Name c:\ps-test\modules\test -Verbose
VERBOSE: Loading module from path ‘C:\ps-test\modules\Test\Test.psm1’.
VERBOSE: Exporting Function ‘my-parm’.
VERBOSE: Exporting Function ‘get-parm’.
VERBOSE: Exporting Function ‘get-spec’.
VERBOSE: Exporting Function ‘get-specDetails’.
Description
———–
This command uses an explicit path to identify the module to import.
It also uses the Verbose common parameter to get a list of the items imported from the module. Without the Verbose, PassThru, or AsCustomObject parameter, Import-Module does not generate any output when it imports a module.
————————– EXAMPLE 5 ————————–
C:\PS>Import-Module BitsTransfer -Cmdlet Add-BitsTransferFile, Get-BitsTransfer
C:\PS> Get-Module BitsTransfer
Name : BitsTransfer
Path : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer\BitsTransfer.psd1
Description :
Guid : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version : 1.0.0.0
ModuleBase : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer
ModuleType : Manifest
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {[Add-BitsTransfer, Add-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer], [Get-BitsTransfer, Get-BitsTransfer], [Rem
ove-BitsTransfer, Remove-BitsTransfer]…}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules : {Microsoft.BackgroundIntelligentTransfer.Management}
C:\PS> Get-Command -module BitsTransfer
CommandType Name Definition
———– —- ———-
Cmdlet Add-BitsTransfer Add-BitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> [[-Destination] <String[]>] [-Verbose] [-Debug] [-ErrorA…
Cmdlet Get-BitsTransfer Get-BitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningActi…
Description
———–
This example shows how to restrict the module members that are imported into the session and the effect of this command on the session.
The first command imports only the Add-BitsTransfer and Get-BitsTransfer cmdlets from the BitsTransfer module. The command uses the Cmdlet parameter to restrict the cmdlets that the module imports. You can also use the Alias, Variable, and Function parameters to restrict other members that a module imports.
The second command uses the Get-Module cmdlet to get the object that represents the BitsTransfer module. The ExportedCmdlets property lists all of the cmdlets that the module exports, even when they were not all imported.
The third command uses the Module parameter of the Get-Command cmdlet to get the commands that were imported from the BitsTransfer module. The results confirm that only the Add-BitsTransfer and Get-BitsTransfer cmdlets were imported.
————————– EXAMPLE 6 ————————–
C:\PS>Import-Module BitsTransfer -Prefix PS -PassThru
Name : bitstransfer
Path : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer\bitstransfer.psd1
Description :
Guid : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version : 1.0.0.0
ModuleBase : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer
ModuleType : Manifest
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {[Add-BitsTransfer, Add-BitsTransfer], [Remove-BitsTransfer, Remove-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer]
, [Get-BitsTransfer, Get-BitsTransfer]…}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules : {Microsoft.BackgroundIntelligentTransfer.Management}
C:\PS> Get-Command -module bitstransfer
CommandType Name Definition
———– —- ———-
Cmdlet Add-PSBitsTransfer Add-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> …
Cmdlet Complete-PSBitsTransfer Complete-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Deb…
Cmdlet Get-PSBitsTransfer Get-PSBitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] …
Cmdlet Remove-PSBitsTransfer Remove-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debug…
Cmdlet Resume-PSBitsTransfer Resume-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Asynchronous] [-…
Cmdlet Set-PSBitsTransfer Set-PSBitsTransfer [-BitsJob] <BitsJob[]> [-DisplayName <String…
Cmdlet Start-PSBitsTransfer Start-PSBitsTransfer [[-Source] <String[]>] [[-Destination] <St…
Cmdlet Suspend-PSBitsTransfer Suspend-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debu…
Description
———–
These commands import the BitsTransfer module into the current session, add a prefix to the member names, and then display the prefixed member names.
The first command uses the Import-Module cmdlet to import the BitsTransfer module. It uses the Prefix parameter to add the PS prefix to all members that are imported from the module and the PassThru parameter to return a module object that represents the imported module.
The module object that the command returns has an ExportedCmdlets property that lists the exported members. The prefix does not appear in the cmdlet names, because it is applied after the members are exported (but before they are imported).
The second command uses the Get-Command cmdlet to get the members that have been imported from the module. It uses the Module parameter to specify the module. The output shows that the module members were correctly prefixed.
The prefix that you use applies only to the members in the current session. It does not change the module.
————————– EXAMPLE 7 ————————–
C:\PS>Get-Module -list | Format-Table -property name, moduletype -auto
Name ModuleType
—- ———-
Show-Calendar Script
BitsTransfer Manifest
PSDiagnostics Manifest
TestCmdlets Script
C:\PS> $a = Import-Module -Name Show-Calendar -AsCustomObject
C:\PS> $a | Get-Member
TypeName: System.Management.Automation.PSCustomObject
Name MemberType Definition
—- ———- ———-
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
Show-Calendar ScriptMethod System.Object Show-Calendar();
C:\PS> $a.”show-calendar”()
Description
———–
These commands demonstrate how to get and use the custom object that Import-Module returns.
Custom objects include synthetic members that represent each of the imported module members. For example, the cmdlets and Functions in a module are converted to script methods of the custom object.
Custom objects are very useful in scripting. They are also useful when several imported objects have the same names. Using the script method of an object is equivalent to specifying the fully qualified name of an imported member, including its module name.
The AsCustomObject parameter can be used only with a script module, so the first task is to determine which of the available modules is a script module.
The first command uses the Get-Module cmdlet to get the available modules. The command uses a pipeline operator (|) to pass the module objects to the Format-Table cmdlet, which lists the Name and ModuleType of each module in a table.
The second command uses the Import-Module cmdlet to import the Show-Calendar script module. The command uses the AsCustomObject parameter to request a custom object. The command saves the resulting custom object in the $a Variable.
The third command uses a pipeline operator to send the $a Variable to the Get-Member cmdlet, which gets the properties and methods of the PSCustomObject in $a. The output shows a Show-Calendar script method.
The last command uses the Show-Calendar script method. The method name must be enclosed in quotation marks, because it includes a hyphen.
————————– EXAMPLE 8 ————————–
C:\PS>Import-Module BitsTransfer
C:\PS> Import-Module BitsTransfer -Force -Prefix PS
Description
———–
This example shows how to use the Force parameter of Import-Module when you are re-importing a module into the same session.
The first command imports the BitsTransfer module. The second command imports the module again, this time using the Prefix parameter.
The second command also includes the Force parameter, which removes the module and then imports it again. Without this parameter, the session would include two copies of each BitsTransfer cmdlet, one with the standard name and one with the prefixed name.
————————– EXAMPLE 9 ————————–
C:\PS>Get-Date
Saturday, September 12, 2009 6:47:04 PM
C:\PS> Import-Module TestModule
C:\PS> Get-Date
09255
C:\PS> Get-Command Get-Date | Format-Table -property commandtype, name, pssnapin, module -auto
CommandType Name pssnapin Module
———– —- ——– ——
Function Get-Date TestModule
Cmdlet Get-Date Microsoft.PowerShell.Utility
C:\PS> Microsoft.PowerShell.Utility\Get-Date
Saturday, September 12, 2009 6:33:23 PM
Description
———–
This example shows how to run commands that have been hidden by imported commands.
The first command run the Get-Date cmdlet that comes with Windows PowerShell. It returns a DateTime object with the current date.
The second command imports the TestModule module. This module includes a Function named Get-Date that returns the Julian date.
The third command runs the Get-Date command again. Because Functions take precedence over cmdlets, the Get-Date Function from the TestModule module ran, instead of the Get-Date cmdlet.
The fourth command shows that there are two Get-Date commands in the session, a Function from the TestModule module and a cmdlet from the Microsoft.PowerShell.Utility snap-in.
The fifth command runs the hidden cmdlet by qualifying the command name with the snap-in name.
For more information about command precedence in Windows PowerShell, see about_command_precedence.
RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=141553
Get-Module
New-Module
Remove-Module
Export-ModuleMember
about_modules