Update-Help
在计算机上下载和安装最新的帮助文件。
语法
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
该 Update-Help
cmdlet 下载 PowerShell 模块的最新帮助文件,并将其安装在计算机上。 无需重启 PowerShell,更改生效。 可以使用 Get-Help
cmdlet 立即查看新的帮助文件。
Update-Help
检查计算机上帮助文件的版本。 如果没有模块的帮助文件,或者帮助文件已过时, Update-Help
请下载最新的帮助文件。 可以从 Internet 或文件共享下载和安装帮助文件。
如果不使用参数, Update-Help
则更新会话中模块的帮助文件,以及支持可更新帮助的所有已安装模块的帮助文件。 包括当前会话中已安装但未加载的模块。 PowerShell 模块存储在环境变量中列出的 $env:PSModulePath
位置。 有关详细信息,请参阅 about_Updatable_Help。
可以使用 Module 参数更新特定模块的帮助文件。 使用 UICulture 参数下载多种语言和区域设置的帮助文件。
还可以在未连接到 Internet 的计算机上使用 Update-Help
。 首先,使用 Save-Help
cmdlet 从 Internet 下载帮助文件,并将其保存在未连接到 Internet 的系统可访问的共享文件夹中。 然后使用 的 SourcePath 参数 Update-Help
从共享的 下载更新的帮助文件并将其安装在计算机上。
可以通过将 cmdlet 添加到 PowerShell 配置文件来 Update-Help
自动执行帮助更新。 默认情况下, Update-Help
每天仅在每台计算机上运行一次。 若要重写每天一次的限制,请使用 Force 参数。
cmdlet Update-Help
是在 Windows PowerShell 3.0 中引入的。
重要
Update-Help
需要 PowerShell 6.0 及更低版本中的管理权限。
PowerShell 6.1 及更高版本将默认 作用域 设置为 CurrentUser
。
在 PowerShell 6.1 之前, Scope 参数不可用。
必须是计算机上的管理员组的成员才能更新 PowerShell Core 模块的帮助文件。
若要下载或更新 PowerShell 安装目录中模块的帮助文件 ($PSHOME\Modules
) ,包括 PowerShell Core 模块,请使用 “以管理员身份运行” 选项启动 PowerShell。
例如:Start-Process pwsh.exe -Verb RunAs
。
示例
示例 1:更新所有模块的帮助文件
cmdlet Update-Help
更新支持可更新帮助的已安装模块的帮助文件。 用户界面 (UI) 区域性语言是在操作系统中设置的。
Update-Help
示例 2:更新指定模块的帮助文件
cmdlet Update-Help
仅更新以 Microsoft.PowerShell 开头的模块名称的帮助文件。
Update-Help -Module Microsoft.PowerShell*
示例 3:更新不同语言的帮助文件
cmdlet Update-Help
更新所有模块的日语 (ja-JP) 和英语 (en-US) 帮助文件。
如果模块没有为指定的 UI 区域性提供帮助文件,则会显示模块和 UI 区域性的错误消息。 在此示例中,错误消息指示找不到模块 Microsoft.PowerShell.Utility 的 ja-JP 帮助文件。
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.
示例 4:从文件共享更新多台计算机上的帮助文件
在此示例中,更新的帮助文件从 Internet 下载并保存在文件共享中。 需要有权访问文件共享和安装更新的用户凭据。 使用文件共享时,可以更新防火墙后面或未连接到 Internet 的计算机。
Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}
命令 Save-Help
下载支持可更新帮助的所有模块的最新帮助文件。
DestinationPath 参数将文件保存在文件共享中\\Server01\Share\PSHelp
。 Credential 参数指定有权访问文件共享的用户。
cmdlet 在 Invoke-Command
多台计算机上运行远程 Update-Help
命令。 ComputerName 参数从 Servers.txt 文件中获取远程计算机的列表。 ScriptBlock 参数运行Update-Help
命令并使用 SourcePath 参数指定包含更新的帮助文件的文件共享。 Credential 参数指定可以访问文件共享并运行远程Update-Help
命令的用户。
示例 5:获取更新的帮助文件的列表
cmdlet Update-Help
更新指定模块的帮助。 cmdlet 使用 Verbose 通用参数显示已更新的帮助文件的列表。 可以使用 详细 来查看所有帮助文件的输出或特定模块的帮助文件的输出。
如果没有 Verbose 参数, Update-Help
则不会显示命令的结果。 详细参数输出可用于验证帮助文件是否已更新或是否已安装最新版本。
Update-Help -Module Microsoft.PowerShell.Utility -Verbose
示例 6:查找支持可更新帮助的模块
此示例列出了支持可更新帮助的模块。 命令使用模块的 HelpInfoUri 属性来标识支持可更新帮助的模块。 HelpInfoUri 属性包含运行 cmdlet 时重定向的Update-Help
地址。
Get-Module -ListAvailable | Where-Object -Property HelpInfoUri
Directory: C:\program files\powershell\6\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 6.1.0.0 CimCmdlets Core {Get-CimAssociatedInstance... }
Manifest 1.2.2.0 Microsoft.PowerShell.Archive Desk {Compress-Archive... }
Manifest 6.1.0.0 Microsoft.PowerShell.Diagnostics Core {Get-WinEvent, New-WinEvent}
Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 2.0.1.0 Appx Core,Desk {Add-AppxPackage, ... }
Script 1.0.0.0 AssignedAccess Core,Desk {Clear-AssignedAccess, ... }
Manifest 1.0.0.0 BitLocker Core,Desk {Unlock-BitLocker, ... }
示例 7:清单更新的帮助文件
在此示例中,脚本 Get-UpdateHelpVersion.ps1
为每个模块及其版本号创建可更新帮助文件的清单。
该脚本通过使用模块的 HelpInfoUri 属性标识支持可更新帮助的模块。 对于支持可更新帮助的模块,脚本会查找并分析帮助信息文件 (*helpinfo.xml) ,以查找最新的版本号。
该脚本使用 PSCustomObject 类和哈希表创建自定义输出对象。
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='https://schemas.microsoft.com/powershell/help/2010/05'}
if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }
foreach ($mModule in $Modules)
{
$mDir = $mModule.ModuleBase
if (Test-Path $mdir\*helpinfo.xml)
{
$mName=$mModule.Name
$mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
foreach ($mNode in $mNodes)
{
$mCulture=$mNode.Node.UICultureName
$mVer=$mNode.Node.UICultureVersion
[PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
}
}
}
ModuleName Culture Version
---------- ------- -------
ActiveDirectory en-US 3.0.0.0
ADCSAdministration en-US 3.0.0.0
ADCSDeployment en-US 3.0.0.0
ADDSDeployment en-US 3.0.0.0
ADFS en-US 3.0.0.0
参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
指定有权访问 SourcePath 指定的文件系统位置的用户的凭据。 仅当命令中使用了 SourcePath 或 LiteralPath 参数时,此参数才有效。
使用 Credential 参数可以在远程计算机上运行Update-Help
具有 SourcePath 参数的命令。 通过提供显式凭据,可以在远程计算机上运行 命令并访问第三台计算机上的文件共享,而不会遇到访问被拒绝错误或使用 CredSSP 身份验证来委托凭据。
键入用户名,例如 User01 或 Domain01\User01,或输入 cmdlet Get-Credential
生成的 PSCredential 对象。 如果键入用户名,系统会提示输入密码。
凭据存储在 PSCredential 对象中,密码存储为 SecureString。
注意
有关 SecureString 数据保护的详细信息,请参阅 SecureString 的安全性如何?。
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
指示此 cmdlet 不遵循每天一次的限制,跳过版本检查并下载超过 1 GB 限制的文件。
如果没有此参数, Update-Help
则每 24 小时仅运行一次。 每个模块的下载限制为 1 GB 的未压缩内容,并且仅当帮助文件比计算机上的现有文件更新时才安装。
每天一次的限制可保护托管帮助文件的服务器,使你能够将命令添加到 Update-Help
PowerShell 配置文件,而不会产生重复连接或下载的资源成本。
若要在没有 Force 参数的情况下,为多个 UI 区域性中的模块更新帮助,请将所有 UI 区域性包括在相同的命令中,例如:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FullyQualifiedModule
指定名称为 ModuleSpecification 对象形式的模块。 模块指定构造函数的备注部分介绍了这些模块 (哈希表) 。
例如, FullyQualifiedModule 参数接受以下格式指定的模块名称:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
或
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName 和 ModuleVersion 是必需的,但 Guid 是可选的。
不能在与 Module 参数相同的命令中指定 FullyQualifiedModule 参数。
Type: | ModuleSpecification[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
指定更新的帮助文件的文件夹,而不是从 Internet 下载它们。 如果使用 cmdlet 将帮助文件下载到目录,Save-Help
请使用此参数或 SourcePath。
可以将目录对象(如 或 Get-Item
Get-ChildItem
cmdlet)管道到 Update-Help
。
与 SourcePath 的值不同, LiteralPath 的值完全按照键入的方式使用。 不会将任何字符解释为通配字符。 如果路径包括转义符,请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Module
为指定模块更新帮助。 在逗号分隔的列表中输入一个或多个模块名称或名称模式,或指定每行上列出一个模块名称的文件。 允许使用通配符。 可以将模块从 Get-Module
cmdlet 管道到 Update-Help
cmdlet。
指定的模块必须安装在计算机上,但不必将其导入到当前会话中。 可以指定会话中的任何模块或安装在环境变量中列出的位置中的任何 $env:PSModulePath
模块。
值 *
(所有) 尝试更新计算机上安装的所有模块的帮助。
包含不支持可更新帮助的模块。 当命令遇到不支持可更新帮助的模块时,此值可能会生成错误。 而是在没有参数的情况下运行 Update-Help
。
cmdlet 的 Update-Help
Module 参数不接受模块文件或模块清单文件的完整路径。 若要更新不在某个位置的 $env:PSModulePath
模块的帮助,请在运行 Update-Help
命令之前将模块导入到当前会话中。
Type: | String[] |
Aliases: | Name |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Recurse
对指定目录中的帮助文件执行递归搜索。 仅当命令使用 SourcePath 参数时,此参数才有效。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
指定更新帮助的系统范围。 AllUsers 范围内的汇报需要 Windows 系统上的管理权限。 参数 -Scope
是在 PowerShell Core 版本 6.1 中引入的。
CurrentUser 是 PowerShell 6.1 及更高版本中帮助文件的默认范围。 可以指定 AllUsers 为所有用户安装或更新帮助。 在 Unix 系统上 sudo
,需要权限才能为所有用户更新帮助。 例如: sudo pwsh -c Update-Help
可接受的值如下:
- CurrentUser
- AllUsers
Type: | UpdateHelpScope |
Position: | Named |
Default value: | CurrentUser |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SourcePath
指定一个文件系统文件夹,用于 Update-Help
获取更新的帮助文件,而不是从 Internet 下载它们。 输入文件夹的路径。 不要指定文件名或文件扩展名。 可以将文件夹(如 或 Get-Item
Get-ChildItem
cmdlet 中的一个文件夹)管道到 Update-Help
。
默认情况下, Update-Help
从 Internet 下载更新的帮助文件。 使用 Save-Help
cmdlet 将更新的帮助文件下载到目录时,请使用 SourcePath。
若要指定 SourcePath 的默认值,请转到组策略、计算机配置和设置 Update-Help 的默认源路径。 此组策略设置可防止用户使用 Update-Help
从 Internet 下载帮助文件。
有关详细信息,请参阅 about_Group_Policy_Settings。
Type: | String[] |
Aliases: | Path |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UICulture
指定用于获取更新的帮助文件的 UI 区域性值 Update-Help
。 输入一个或多个语言代码,例如 es-ES、包含区域性对象的变量或获取区域性对象的命令,如 Get-Culture
或 Get-UICulture
命令。 不允许使用通配符,并且无法提交部分语言代码,例如 de。
默认情况下, Update-Help
获取操作系统的 UI 区域性集中的帮助文件。 如果指定 UICulture 参数, Update-Help
请仅查找指定 UI 区域性的帮助。
注意
Ubuntu 18.04 将默认区域设置更改为 C.UTF.8
,这不是可识别的 UI 区域性。 Update-Help
除非将此参数与受支持的区域设置(如 ) en-US
一起使用,否则无法以无提示方式下载帮助。 这可能在使用不受支持的值的任何平台上发生。
仅当模块为指定的 UI 区域性提供帮助文件时,使用 UICulture 参数的命令才会成功。 如果命令因不支持指定的 UI 区域性而失败,则会显示一条错误消息。
Type: | CultureInfo[] |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseDefaultCredentials
指示 Update-Help
使用当前用户的凭据运行命令,包括 Internet 下载。 默认情况下,在没有显式凭据的情况下运行该命令。
仅当 Web 下载使用 NT LAN Manager (NTLM) 、协商或基于 Kerberos 的身份验证时,此参数才有效。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
输入
可以通过管道将目录路径传递给 Update-Help
。
可以通过管道将模块对象从 Get-Module
cmdlet 传递给 Update-Help
。
输出
None
Update-Help
不会生成任何输出。
备注
若要更新 PowerShell Core 模块(其中包含随 PowerShell 一起安装的命令)或目录中的任何模块的 $PSHOME\Modules
帮助,请使用“ 以管理员身份运行”选项启动 PowerShell。
只有计算机上的 Administrators 组的成员才能更新 PowerShell Core 模块、与 PowerShell 一起安装的命令以及文件夹中模块的 $PSHOME\Modules
帮助。 如果你没有更新帮助文件的权限,可以联机读取帮助文件。 例如 Get-Help Update-Help -Online
。
模块是可更新帮助的最小单位。 无法更新特定 cmdlet 的帮助。 若要查找包含特定 cmdlet 的模块,请使用 cmdlet 的 Get-Command
ModuleName 属性,例如 (Get-Command Update-Help).ModuleName
。
由于帮助文件安装在模块目录中,因此 Update-Help
cmdlet 只能为计算机上安装的模块安装更新的帮助文件。 但是,cmdlet Save-Help
可以为计算机上未安装的模块保存帮助。
如果 Update-Help
找不到模块的更新帮助文件,或者找不到指定语言的更新帮助,它会以静默方式继续,而不会显示错误消息。 若要查看状态和进度的详细信息,请使用 Verbose 参数。
cmdlet Update-Help
是在 Windows PowerShell 3.0 中引入的。 它在早期版本的 PowerShell 中不起作用。 在同时具有 Windows PowerShell 2.0 和 Windows PowerShell 3.0 的计算机上,在 Windows PowerShell 3.0 会话中使用 Update-Help
cmdlet 下载和更新帮助文件。 帮助文件适用于 Windows PowerShell 2.0 和 Windows PowerShell 3.0。
Update-Help
和 Save-Help
cmdlet 使用以下端口下载帮助文件:用于 HTTP 的端口 80 和用于 HTTPS 的端口 443。
Update-Help
支持所有模块和 PowerShell Core 管理单元。它不支持任何其他管理单元。
若要更新环境变量中未列出的位置的模块的 $env:PSModulePath
帮助,请将该模块导入当前会话,然后运行 Update-Help
命令。 在没有参数的情况下运行 Update-Help
,或使用 Module 参数指定模块名称。 和 Save-Help
cmdlet 的 Update-Help
Module 参数不接受模块文件或模块清单文件的完整路径。
所有模块都支持可更新帮助。 有关在创作的模块中支持可更新帮助的说明,请参阅 支持可更新的帮助。
Update-Help
Windows 预安装环境 (Windows PE) 不支持 和 Save-Help
cmdlet。