Save-Help

Синтаксис

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

Save-Help
    -LiteralPath <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

Описание

Командлет Save-Help скачивает новейшие файлы справки для модулей PowerShell и сохраняет их в указанный каталог. Эта функция позволяет обновлять файлы справки на компьютерах без доступа к Интернету и упрощает обновление файлов справки на нескольких компьютерах.

В Windows PowerShell 3.0 Save-Help работал только для модулей, установленных на локальном компьютере. Хотя можно было импортировать модуль с удаленного компьютера или получить ссылку на объект PSModuleInfo с удаленного компьютера с помощью удаленного взаимодействия PowerShell, свойство HelpInfoUri не сохранялось и Save-Help не работало для справки по удаленному модулю.

В Windows PowerShell 4.0 свойство HelpInfoUri сохраняется через удаленное взаимодействие PowerShell, которое позволяет Save-Help работать для модулей, установленных на удаленных компьютерах. Кроме того, можно сохранить объект PSModuleInfo на диск или съемный носитель, выполнив на Export-Clixml компьютере, который не имеет доступа к Интернету, импортировать объект на компьютере с доступом к Интернету, а затем запустить Save-Help его в объекте PSModuleInfo . Сохраненную справку можно перенести на удаленный компьютер с помощью съемных носителей, таких как USB-накопитель. Справка может быть установлена на удаленном компьютере, выполнив команду Update-Help. Этот процесс можно использовать для установки справки на компьютерах без доступа к какой-либо сети.

Чтобы установить сохраненные файлы справки Update-Help , запустите командлет. Добавьте его параметр SourcePath , чтобы указать папку, в которой вы сохранили файлы справки.

Без параметров Save-Help команда загружает последнюю справку для всех модулей в сеансе и для модулей, установленных на компьютере в расположении, указанном в переменной среды PSModulePath . Это действие пропускает модули, которые не поддерживают обновляемую справку без предупреждения.

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

Сохраненные файлы справки для каждого модуля — это один файл сведений о справке (HelpInfo XML) и по одному CAB-файлу для каждого языка пользовательского интерфейса. Вам не нужно извлекать файлы справки из файла шкафа. Командлет Update-Help извлекает файлы справки, проверяет XML для безопасности, а затем устанавливает файлы справки и файл сведений справки в вложенной папке модуля для конкретного языка.

Чтобы сохранить файлы справки для модулей в папке установки PowerShell ($pshome\Modules), запустите PowerShell с помощью параметра "Запуск от имени администратора". Для загрузки файлов справки для этих модулей необходимо быть членом группы администраторов на компьютере.

Этот командлет впервые появился в Windows PowerShell 3.0.

Примеры

Пример 1. Сохранение справки для модуля DhcpServer

# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module,
# save the PSModuleInfo object in the variable $m, and then run Save-Help.

$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock { Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath "C:\SavedHelp"


# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

$s = New-PSSession -ComputerName "RemoteServer"
$m = Get-Module -PSSession $s -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"


# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

$c = New-CimSession -ComputerName "RemoteServer"
$m = Get-Module -CimSession $c -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"

В этом примере показаны три разных способа Save-Help сохранения справки для модуля DhcpServer с клиентского компьютера, подключенного к Интернету, без установки модуля DHCPServer или роли DHCP-сервера на локальном компьютере.

Пример 2. Установка справки по модулю DhcpServer

# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.

$m = Get-Module -Name "DhcpServer" -ListAvailable
Export-CliXml -Path "E:\UsbFlashDrive\DhcpModule.xml" -InputObject $m

# Next, transport the removable media to a computer that has Internet access, and then import the
# PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer
# module PSModuleInfo object.

$deserialized_m = Import-CliXml "E:\UsbFlashDrive\DhcpModule.xml"
Save-Help -Module $deserialized_m -DestinationPath "E:\UsbFlashDrive\SavedHelp"

# Finally, transport the removable media back to the computer that does not have network access, and
# then install the help by running Update-Help.

Update-Help -Module DhcpServer -SourcePath "E:\UsbFlashDrive\SavedHelp"

В этом примере показано, как установить справку, сохраненную в примере 1 для модуля DhcpServer на компьютере, который не имеет доступа к Интернету.

Пример 3. Сохранение справки для всех модулей

Save-Help -DestinationPath "\\Server01\FileShare01"

Эта команда загружает последние файлы справки для всех модулей для языка Windows на локальном компьютере. Он сохраняет файлы справки в папке \\Server01\Fileshare01 .

Пример 4. Сохранение справки по модулю на компьютере

Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01

Эта команда скачивает самые новые файлы справки для модуля ServerManager , а затем сохраняет их в папке \\Server01\Fileshare01 .

При установке модуля на компьютере можно ввести имя модуля в качестве значения параметра модуля , даже если модуль не импортируется в текущий сеанс.

Команда использует параметр Credential для предоставления учетных данных пользователя, имеющего разрешение на запись в общую папку.

Пример 5. Сохранение справки для модуля на другом компьютере

Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Эти команды загружают самые новые файлы справки для модуля CustomSQL и сохраняют их в папке \\Server01\Fileshare01 .

Так как модуль CustomSQL не установлен на компьютере, последовательность включает Invoke-Command команду, которая получает объект модуля для модуля CustomSQL с компьютера Server02, а затем передает объект модуля командлетуSave-Help.

Если модуль не установлен на компьютере, Save-Help требуется объект модуля, содержащий сведения о расположении новейших файлов справки.

Пример 6. Сохранение справки по модулю на нескольких языках

Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"

Эта команда сохраняет справку для основных модулей PowerShell в четырех разных языках и региональных параметрах пользовательского интерфейса. Языковые пакеты для этих языковых стандартов не должны быть установлены на компьютере.

Save-Help может скачать файлы справки для модулей в разных языках и региональных параметрах пользовательского интерфейса, только если владелец модуля делает переведенные файлы доступными в Интернете.

Пример 7. Сохранение справки несколько раз в день

Save-Help -Force -DestinationPath "\\Server3\AdminShare\Help"

Эта команда сохраняет справку для всех модулей, которые установлены на компьютере. Команда задает параметр Force для переопределения правила, которое запрещает Save-Help командлету загружать справку более одного раза в течение каждого 24-часового периода.

Параметр Force также переопределяет ограничение в 1 ГБ и обходит проверку версий. Таким образом, файлы можно скачать, даже если версия не превышает версию в целевой папке.

Команда использует Save-Help командлет для скачивания и сохранения файлов справки в указанной папке. Параметр Force требуется при выполнении Save-Help команды более одного раза в день.

Параметры

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Scope

-UICulture

-UseDefaultCredentials

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

PSModuleInfo

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

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

None

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

Примечания

• Чтобы сохранить справку по модулям в папке $pshome\Modules, запустите PowerShell с помощью параметра "Запуск от имени администратора". Только члены группы администраторов на компьютере могут скачать справку по модулям в папке $pshome\Modules.
• Сохраненные файлы справки для каждого модуля — это один файл сведений о справке (HelpInfo XML) и по одному CAB-файлу для каждого языка пользовательского интерфейса. Вам не нужно извлекать файлы справки из файла шкафа. Командлет Update-Help извлекает файлы справки, проверяет XML, а затем устанавливает файлы справки и файл сведений справки в вложенную папку модуля для конкретного языка.
• Командлет Save-Help может сохранить справку для модулей, которые не установлены на компьютере. Однако, так как файлы справки установлены в папке модуля, Update-Help командлет может установить обновленный файл справки только для модулей, установленных на компьютере.
• Если Save-Help не удается найти обновленные файлы справки для модуля или найти обновленные файлы справки на указанном языке, он продолжается без отображения сообщения об ошибке. Чтобы узнать, какие файлы были сохранены командой, укажите подробный параметр.
• Модули — это наименьшая единица обновляемой справки. Не удается сохранить справку для определенного командлета только для всех командлетов в модуле. Чтобы найти модуль, содержащий определенный командлет, используйте свойство ModuleName вместе с командлетом Get-Command , например (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help поддерживает все модули и основные оснастки PowerShell. Она не поддерживает другие оснастки.
• Save-Help Командлеты Update-Help используют следующие порты для скачивания файлов справки: порт 80 для HTTP и порта 443 для HTTPS.
• Save-Help Командлеты Update-Help не поддерживаются в среде предустановки Windows (Windows PE).

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

• Get-Help
• Get-Module
• Update-Help