简短说明
介绍如何安装、导入和使用 PowerShell 模块。
详细说明
PowerShell 是一种脚本语言和命令 shell。 该语言由 关键字和命令组成,关键字提供处理的结构和逻辑,以及执行工作的命令。 PowerShell 中的命令作为脚本、函数或 cmdlet 实现。
模块是一个自包含的可重用单元,可以包含 cmdlet、提供程序、函数、变量和可以作为单个单元导入的其他类型的资源。
PowerShell 附带一组基本模块。 您还可以根据需要安装更多模块。 默认情况下,首次使用模块中的命令时,会自动加载已安装的模块。 使用该 $PSModuleAutoloadingPreference 变量来启用、禁用和配置模块的自动加载。 有关详细信息,请参阅 about_Preference_Variables。
您可以在会话期间卸载或重新加载。
Remove-Module使用 cmdlet 从会话中卸载模块。
Import-Module使用 cmdlet 加载模块。
模块可以创建为用 C# 编写的已编译 .NET 程序集,也可以创建用 PowerShell 编写的基于脚本的模块。 本主题介绍如何使用 PowerShell 模块。 有关如何编写 PowerShell 模块的信息,请参阅 编写 PowerShell 模块。
注释
在 PowerShell 3.0 之前,命令和提供程序被打包在 PowerShell 管理单元中。从 PowerShell 3.0 开始,默认会将 Microsoft.PowerShell.Core 管理单元添加到每个会话。 这是 PowerShell 中仅存的一个快速插件。 所有其他快件都已转换为模块。 不再支持创建新的快显。
安装已发布的模块
已发布的模块是可从已注册的存储库(如 PowerShell 库)获取的模块。 PowerShellGet 和 Microsoft.PowerShell.PSResourceGet 模块提供了用于查找、安装和发布 PowerShell 模块到已注册存储库的 cmdlet。
PowerShell 5.0 及更高版本随附了 PowerShellGet 模块。
Microsoft.PowerShell.PSResourceGet 模块包含在 PowerShell 7.4 及更高版本中。
Microsoft.PowerShell.PSResourceGet 是 PowerShell 的新首选包管理器,可以安装在以前版本的 PowerShell 上。 使用 Install-Module 或 Install-PSResource cmdlet 从 PowerShell 库安装模块。
Get-Command Install-Module, Install-PSResource
CommandType Name Version Source
----------- ---- ------- ------
Function Install-Module 2.9.0 PowerShellGet
Cmdlet Install-PSResource 1.0.0 Microsoft.PowerShell.PSResourceGet
有关详细信息,请参阅 PowerShellGet 概述。
手动安装模块
如果您以文件夹的形式接收模块,其中包含文件,则需要先将其安装在您的计算机上,然后才能在 PowerShell 中使用它。
PowerShell 附带了几个预安装的模块。 在基于 Windows 的计算机上,许多 Windows 功能都包含用于管理该功能的模块。 这些模块在安装功能时安装。 其他模块可能来自安装模块的安装程序或安装程序中。
默认情况下,当前用户的 Modules 文件夹不存在。 如果使用 CurrentUser 或 Install-Module在 Install-PSResource 范围内安装了模块,则这些 cmdlet 将为当前用户创建 Modules 文件夹。 如果文件夹不存在,可以手动创建它。
使用以下命令为当前用户创建 Modules 文件夹:
$folder = New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules
将整个模块文件夹复制到新创建的文件夹中。 在 PowerShell 中使用 Copy-Item cmdlet。 例如,运行以下命令将 MyModule 文件夹从 C:\PSTest 复制到您刚刚创建的文件夹:
Copy-Item -Path C:\PSTest\MyModule -Destination $folder
可以在任何位置安装模块,但在默认模块位置安装模块可以更轻松地管理模块。 有关默认模块位置的详细信息,请参阅 about_PSModulePath。
模块自动加载
首次从已安装的模块运行命令时,PowerShell 会自动导入该模块(加载)。 模块必须存储在 $env:PSModulePath 环境变量中指定的位置。 其他位置的模块必须使用 cmdlet 导入 Import-Module 。
模块自动加载允许您在模块中使用命令,而无需任何预先设置或配置文件。 将模块安装到计算机上后,无需管理模块。
以下每个示例都会导致将包含 Get-CimInstance的 CimCmdlets 模块导入到会话中。
运行命令
Get-CimInstance Win32_OperatingSystem获取命令
Get-Command Get-CimInstance获取命令的帮助
Get-Help Get-CimInstance
您可以使用 Get-Command cmdlet 列出所有已安装模块中的命令,即使它们尚未在会话中。 将 Get-Command 与通配符(*)一起使用时,PowerShell 不会导入任何模块。 您可以使用通配符进行命令发现,而无需加载会话中可能不需要的模块。
此外,使用 PowerShell 提供程序的命令不会自动导入模块。 例如,如果使用需要 WSMan: 驱动器(如 Get-PSSessionConfiguration cmdlet)的命令,则可能需要运行 Import-Module cmdlet 来导入包含 驱动器的 WSMan: 模块。
手动导入模块
当模块未安装在由 $env:PSModulePath 环境变量指定的位置,或者当模块作为独立 .dll 或 .psm1 文件提供(而不是打包模块)时,需要手动导入模块。
你可能还想要更改模块在会话中导入的方式。 例如, 的 Import-Module 参数向从模块导入的 cmdlet 的名词部分添加一个独特的前缀。
NoClobber 参数可防止模块添加命令,这些命令将隐藏或替换会话中的现有命令。 有关详细信息,请参阅 管理名称冲突。
您可以通过指定模块名称来导入安装在 中的 $env:PSModulePath 模块。 例如,以下命令将 BitsTransfer 模块导入到当前会话中。
Import-Module BitsTransfer
若要导入不在 $env:PSModulePath中的模块,请使用模块文件夹的完全限定路径。 例如,若要将 目录中的 C:\ps-test 模块添加到会话,请键入:
Import-Module C:\ps-test\TestCmdlets
若要导入模块文件夹中不包含的模块文件,请使用命令中模块文件的完全限定路径。 例如,若要将 C:\ps-test 目录中的 TestCmdlets.dll 模块添加到会话,请键入:
Import-Module C:\ps-test\TestCmdlets.dll
有关将模块添加到会话的详细信息,请参阅 Import-Module。
在每个会话开始时导入模块
Import-Module 命令将模块导入到当前的 PowerShell 会话中。 若要将模块导入到启动的每个 PowerShell 会话中,请将 Import-Module 命令添加到 PowerShell 配置文件。
有关配置文件的详细信息,请参阅 about_Profiles。
查找已安装的模块
该 Get-Module cmdlet 获取已在会话中导入的 PowerShell 模块。
Get-Module
列出的模块可以包括从任何位置导入的模块,而不仅仅是从 $env:PSModulePath导入的模块。
使用以下命令列出安装在 $env:PSModulePath中的模块:
Get-Module -ListAvailable
此命令获取安装在 $env:PSModulePath中的所有模块,而不仅仅是导入到当前会话中的模块。 此命令不会列出在其他位置安装的模块。
更多信息, 看看 获取模块.
列出模块中的命令
使用 Get-Command cmdlet 查找所有可用的命令。 可以使用 Get-Command cmdlet 的参数按模块、名称和名词等筛选命令。
若要查找模块中的所有命令,请键入:
Get-Command -Module <module-name>
例如,若要在 BitsTransfer 模块中找到命令,请键入:
Get-Command -Module BitsTransfer
有关 Get-Command cmdlet 的详细信息,请参阅 Get-Command。
删除模块
删除模块时,模块添加的命令将从会话中删除。 例如,以下命令从当前会话中删除 BitsTransfer 模块。
Remove-Module BitsTransfer
删除模块会逆转导入模块的过程。 删除模块不会卸载该模块。 有关详细信息,请参阅 Remove-Module。
可以通过模块和快显将命令添加到会话中。模块可以添加所有类型的命令,包括 cmdlets、提供程序和函数,以及变量、别名和 PowerShell 驱动器等项目。 管理单元只可以添加 cmdlet 和提供程序。
在从会话中删除模块之前,请使用以下命令确定要删除的模块。
例如,使用以下命令查找 Get-Date 和 Get-Help cmdlet 的源:
Get-Command Get-Date, Get-Help -All |
Select-Object -Property Name, CommandType, Module ,PSSnapIn
以下输出表明 Get-Help cmdlet 位于 Microsoft.PowerShell.Core 插件中。 无法从会话中移除此快件。
Name CommandType Module PSSnapIn
---- ----------- ------ --------
Get-Date Function
Get-Date Cmdlet Microsoft.PowerShell.Utility
Get-Help Cmdlet Microsoft.PowerShell.Core
有两个来源 Get-Date. 一个是函数,另一个是 Microsoft.PowerShell.Utility 模块中的 cmdlet。 可以使用 Remove-Module删除模块。 若要删除函数,可以从 Function: 驱动器中删除它。
Remove-Item Function:Get-Date
有关 Function: 驱动器的详细信息,请参阅 about_Function_Provider。
管理名称冲突
当会话中的多个命令具有相同名称时,会发生名称冲突。 当模块中的命令与会话中的命令或项具有相同的名称时,导入模块会导致名称冲突。
Import-Module 可能会添加命令来隐藏和替换当前会话中的命令。 名称冲突可能会导致命令被隐藏或替换。 当导入的模块包含与会话中的现有命令同名的命令时,会发生命令替换。 新导入的命令 replace 优先于现有命令。
例如,当会话包含具有相同名称的函数和 cmdlet 时,PowerShell 默认运行该函数。 默认情况下,当会话包含具有相同名称的相同类型的命令(例如两个具有相同名称的 cmdlet)时,它将运行最近添加的命令。
有关详细信息,包括优先规则的说明以及运行隐藏命令的指示,请参阅 about_Command_Precedence。
您可以运行已被隐藏或替换为限定命令名称的命令。 要限定命令名称,请添加 name of module than 包含所需命令的版本。 例如:
Microsoft.PowerShell.Utility\Get-Date
使用带有模块名称前缀的 Get-Date 可确保运行来自 Microsoft.PowerShell.Utility 模块的版本。
若要检测名称冲突,请使用 cmdlet 的 Get-Command 参数。 默认情况下,Get-Command 仅获取键入命令名称时运行的命令。
All 参数获取会话中具有特定名称的所有命令。
若要防止名称冲突,请使用 cmdlet 的 NoClobber 或 Import-Module 参数。
Prefix 参数将前缀添加到导入的命令的名称中,以便它们在会话中是唯一的。
NoClobber 参数不会导入那些可能会隐藏或替换当前会话中现有命令的命令。
还可以使用 别名、Cmdlet、函数和 Import-Module 参数来仅选择要导入的命令,并且可以排除导致会话中名称冲突的命令。
模块作者可以使用模块清单的 DefaultCommandPrefix 属性来阻止名称冲突,从而将所有命令名称添加默认前缀。 Prefix 参数的值优先于 DefaultCommandPrefix的值。