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 скачивает новейшие файлы справки для модулей PowerShell и устанавливает их на компьютере. Для эффективного изменения не требуется перезапустить PowerShell. Командлет можно использовать Get-Help для немедленного просмотра новых файлов справки.

Update-Help проверяет версию файлов справки на компьютере. Если у вас нет файлов справки для модуля или если файлы справки устарели, Update-Help скачивает новейшие файлы справки. Файлы справки можно скачать и установить из Интернета или общей папки.

Без параметров обновляет файлы справки для модулей, Update-Help которые поддерживают обновляемую справку и загружаются в сеансе или устанавливаются в расположении, включенном в каталог $env:PSModulePath. Дополнительные сведения см. в статье about_Updatable_Help.

Update-Help проверяет версию установленной справки. Если Update-Help не удается найти обновленные файлы справки для модуля, он продолжается без отображения сообщения об ошибке. Используйте параметр Force, чтобы пропустить проверку версии. Используйте подробный параметр для просмотра сведений о состоянии и ходе выполнения. Используйте параметр модуля для обновления файлов справки для определенного модуля.

Вы также можете использовать Update-Help на компьютерах, которые не подключены к Интернету. Сначала используйте Save-Helpкомандлет, чтобы скачать файлы справки из Интернета и сохранить их в общей папке, доступной системе, не подключенной к Интернету. Затем используйте параметр SourcePath , Update-Help чтобы скачать обновленные файлы справки с общего доступа и установить их на компьютере.

Командлет Update-Help появился в Windows PowerShell 3.0.

Примеры

Пример 1. Обновление файлов справки для всех модулей

Командлет Update-Help обновляет файлы справки для установленных модулей, поддерживающих обновляемую справку. Язык языка языка и региональных параметров пользовательского интерфейса устанавливается в операционной системе.

Update-Help

Пример 2. Обновление файлов справки для указанных модулей

Командлет Update-Help обновляет файлы справки только для имен модулей, начинающихся с Microsoft.PowerShell.

Update-Help -Module Microsoft.PowerShell*

Пример 3. Обновление справки в системе не задано для языкового стандарта en-US

Update-Help Командлет предназначен для скачивания справки на нескольких языках. Однако при отсутствии справки для языка, который используется системой, отображается сообщение об ошибке для модуля и языка и региональных параметров пользовательского интерфейса.

В этом примере Update-Help выполняется в системе, настроенной на языковой en-GB стандарт.

Update-Help Microsoft.PowerShell.Utility -Force

Update-Help: Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with
UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a culture
from the following list: {en-US}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.

Файлы справки всегда публикуются для языкового en-US стандарта. Чтобы скачать справку по английскому языку, запустите Update-Help с помощью параметра UICulture и укажите языковой en-US стандарт.

Пример 4. Обновление файлов справки на нескольких компьютерах из общей папки

В этом примере обновленные файлы справки загружаются из Интернета и сохраняются в общей папке. Необходимы учетные данные пользователя, имеющие разрешения на доступ к общей папке и установке обновлений. При использовании общей папки можно обновить компьютеры, которые находятся за брандмауэрами или не подключены к Интернету.

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 указывает пользователя, имеющего разрешение на доступ к общей папке.

Командлет Invoke-Command выполняет удаленные Update-Help команды на нескольких компьютерах. Параметр ComputerName получает список удаленных компьютеров из файла Servers.txt . Параметр ScriptBlock запускает Update-Help команду и использует параметр SourcePath для указания общей папки, содержащей обновленные файлы справки. Параметр Credential указывает пользователя, который может получить доступ к общей папке и запустить удаленную Update-Help команду.

Пример 5. Получение списка обновленных файлов справки

Справка Update-Help по обновлению командлета для указанного модуля. Командлет использует подробный общий параметр для отображения списка обновленных файлов справки. Подробные сведения можно использовать для просмотра выходных данных для всех файлов справки или файлов справки для определенного модуля.

Без параметра Verbose Update-Help не отображает результаты команды. Выходные данные подробных параметров полезны, чтобы убедиться, что файлы справки были обновлены или установлены последние версии.

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

Пример 6. Поиск модулей, поддерживающих обновляемую справку

В этом примере перечислены модули, поддерживающие обновляемую справку. Команда использует свойство HelpInfoUri модуля для идентификации модулей, поддерживающих обновляемую справку. Свойство HelpInfoUri содержит URL-адрес, перенаправленный при запуске командлета 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='http://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

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-Scope

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Входные данные

DirectoryInfo

Объект пути к каталогу можно передать в этот командлет.

PSModuleInfo

Объект модуля можно передать в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

Чтобы обновить справку для основных модулей PowerShell, содержащих команды, установленные с помощью PowerShell или любого модуля в $PSHOME\Modules каталоге, запустите PowerShell с параметром запуска от имени администратора.

Только члены группы администраторов на компьютере могут обновить справку по основным модулям PowerShell, командам, установленным вместе с PowerShell и модулям в папке $PSHOME\Modules . Если у вас нет разрешения на обновление файлов справки, вы можете прочитать файлы справки в Интернете. Например, Get-Help Update-Help -Online.

Модули — это наименьшая единица обновляемой справки. Не удается обновить справку для определенного командлета. Чтобы найти модуль, содержащий определенный командлет, используйте свойство Get-Command ModuleName командлета, например(Get-Command Update-Help).ModuleName.

Так как файлы справки устанавливаются в каталоге модулей, Update-Help командлет может установить обновленный файл справки только для модулей, установленных на компьютере. Save-Help Однако командлет может сохранить справку для модулей, которые не установлены на компьютере.

Командлет Update-Help появился в Windows PowerShell 3.0. Он не работает в более ранних версиях PowerShell. На компьютерах с Windows PowerShell 2.0 и Windows PowerShell 3.0 используйте Update-Help командлет в сеансе Windows PowerShell 3.0 для скачивания и обновления файлов справки. Файлы справки доступны для Windows PowerShell 2.0 и Windows PowerShell 3.0.

Save-Help Командлеты Update-Help используют следующие порты для скачивания файлов справки: порт 80 для HTTP и порта 443 для HTTPS.

Update-Help поддерживает все модули и основные оснастки PowerShell. Она не поддерживает другие оснастки.

Чтобы обновить справку по модулю в расположении, которое не указано в $env:PSModulePath переменной среды, импортируйте модуль в текущий сеанс и выполните Update-Help команду. Запустите Update-Help без параметров или используйте параметр модуля для указания имени модуля. Параметр Update-Help модуля и Save-Help командлетов не принимает полный путь к файлу модуля или файлу манифеста модуля.

Любой модуль может поддерживать обновляемую справку. Инструкции по поддержке обновляемой справки в модулях, которые вы создаете, см. в статье "Поддержка обновляемой справки".

Save-Help Командлеты Update-Help не поддерживаются в среде предустановки Windows (Windows PE).

Связанные ссылки

• Get-Culture
• Get-Help
• Get-Module
• Get-UICulture
• Start-Job
• Save-Help