Udostępnij za pośrednictwem

about_Updatable_Help

  • Artykuł

Krótki opis

Opisuje aktualizowalny system pomocy w programie PowerShell.

Długi opis

Program PowerShell udostępnia kilka różnych sposobów uzyskiwania dostępu do najbardziej aktualnych tematów pomocy dotyczących poleceń cmdlet i pojęć programu PowerShell.

System Pomocy z możliwością aktualizacji, wprowadzony w programie PowerShell 3.0, został zaprojektowany w celu zapewnienia, że zawsze masz najnowsze tematy pomocy na komputerze lokalnym, aby można je było odczytać w wierszu polecenia. Ułatwia pobieranie i instalowanie plików pomocy oraz aktualizowanie ich za każdym razem, gdy nowsze pliki pomocy staną się dostępne.

Aby zapewnić zaktualizowaną pomoc dla wielu komputerów w przedsiębiorstwie i dla komputerów, które nie mają dostępu do Internetu, funkcja Updatable Help umożliwia pobranie plików pomocy do katalogu systemu plików lub udziału plików, a następnie zainstalowanie plików pomocy z udziału plików.

W programie PowerShell 4.0 właściwość HelpInfoUri jest zachowywana za pośrednictwem komunikacji zdalnej programu Windows PowerShell, która umożliwia Save-Help pracę z modułami zainstalowanymi na komputerze zdalnym, ale nie muszą być zainstalowane na komputerze lokalnym. Obiekt PSModuleInfo można zapisać na dysku lub nośniku wymiennym (takim jak dysk USB), uruchamiając Export-Clixml polecenie na komputerze, który nie ma dostępu do Internetu, importując obiekt PSModuleInfo na komputerze, który ma dostęp do Internetu, a następnie uruchomiony Save-Help w obiekcie PSModuleInfo. Zapisaną pomoc można skopiować na zdalny, odłączony komputer przy użyciu nośnika wymiennego, a następnie zainstalować, uruchamiając polecenie Update-Help. Te ulepszenia funkcji Save-Help umożliwiają zainstalowanie pomocy na komputerach, które nie mają żadnego rodzaju dostępu do sieci. Aby zapoznać się z przykładem korzystania z nowych Save-Help funkcji, zobacz Jak zaktualizować pomoc z udziału plików w tym temacie.

Pomoc aktualizowalna obsługuje również dostęp online do najnowszych tematów pomocy i podstawową pomoc dotyczącą poleceń cmdlet, nawet jeśli na komputerze nie ma żadnych plików pomocy.

Program PowerShell nie zawiera plików Pomocy. Za pomocą funkcji Updatable Help można zainstalować pliki pomocy dla wszystkich poleceń, które są domyślnie zawarte w programie PowerShell i dla wszystkich modułów systemu Windows.

Polecenia cmdlet pomocy z możliwością aktualizacji

  • Update-Help: pobiera najnowsze pliki pomocy z Internetu lub udziału plików i instaluje je na komputerze lokalnym.

  • Save-Help: pobiera najnowsze pliki pomocy z Internetu i zapisuje je w katalogu systemu plików lub udziale plików. Aby zainstalować pliki pomocy na komputerach, użyj polecenia Update-Help.

  • Get-Help: wyświetla tematy pomocy w wierszu polecenia. Pobiera pomoc z plików pomocy na komputerze. Wyświetla automatycznie wygenerowaną pomoc dla poleceń cmdlet i funkcji, które nie mają plików pomocy. Otwiera tematy pomocy online dotyczące poleceń cmdlet, funkcji, skryptów i przepływów pracy w domyślnej przeglądarce internetowej.

Pomoc wygenerowana automatycznie: pomoc bez plików pomocy

Jeśli nie masz pliku pomocy dla polecenia cmdlet, funkcji lub przepływu pracy na komputerze, Get-Help polecenie cmdlet wyświetli automatycznie wygenerowaną pomoc i wyświetli monit o pobranie plików pomocy lub odczytanie ich w trybie online.

Automatycznie wygenerowana pomoc zawiera składnię i aliasy oraz uwagi, które wyjaśniają, jak używać poleceń cmdlet Pomocy z możliwością aktualizowania oraz uzyskiwać dostęp do tematów pomocy online.

Na przykład następujące polecenie pobiera podstawową pomoc dotyczącą Get-Culture polecenia cmdlet. Dane wyjściowe pokazują Get-Help wyświetlanie, gdy na komputerze nie ma żadnych plików pomocy.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Pliki pomocy dla modułów

Najmniejszą jednostką pomocy z możliwością aktualizowania jest pomoc dla modułu. Pomoc dotycząca modułu obejmuje pomoc dla wszystkich poleceń cmdlet, funkcji, przepływów pracy, dostawców, skryptów i pojęć w module. Możesz zaktualizować pomoc dotyczącą wszystkich modułów zainstalowanych na komputerze, nawet jeśli nie zostaną zaimportowane do bieżącej sesji.

Możesz zaktualizować pomoc dotyczącą całego modułu, ale nie można zaktualizować pomocy dla poszczególnych poleceń cmdlet.

Aby znaleźć moduł zawierający określone polecenie cmdlet, użyj następującego formatu polecenia:

(Get-Command <cmdlet-name>).ModuleName

Aby na przykład znaleźć moduł zawierający Set-ExecutionPolicy polecenie cmdlet, wpisz:

(Get-Command Set-ExecutionPolicy).ModuleName

Aby zaktualizować pomoc dotyczącą określonego modułu, wpisz:

Update-Help -Module <ModuleName>

Aby na przykład zaktualizować pomoc dotyczącą modułu zawierającego polecenie cmdlet Set-ExecutionPolicy, wpisz:

Update-Help -Module Microsoft.PowerShell.Security

Uprawnienia do aktualizowalnej pomocy

Aby zaktualizować pomoc dotyczącą modułów w katalogu $pshome/Modules, musisz być członkiem grupy Administratorzy na komputerze.

Jeśli nie jesteś członkiem grupy Administratorzy, nie możesz zaktualizować pomocy dotyczącej tych modułów; ale jeśli masz dostęp do Internetu, możesz wyświetlić pomoc online.

Aktualizowanie pomocy dotyczącej modułów w katalogu $HOME/Documents/PowerShell/Modules lub modułach w innych podkatalogach $HOME katalogu nie wymaga specjalnych uprawnień.

Polecenia Update-Help cmdlet i Save-Help mają parametr UseDefaultCredentials , który udostępnia jawne poświadczenia bieżącego użytkownika. Ten parametr jest przeznaczony do uzyskiwania dostępu do bezpiecznych lokalizacji internetowych.

Polecenia Update-Help cmdlet i Save-Help mają również parametr Credential , który umożliwia uruchamianie polecenia na komputerze zdalnym i uzyskiwanie dostępu do udziału plików na trzecim komputerze. Parametr Credential jest prawidłowy tylko wtedy, gdy używasz parametrów SourcePath lub LiteralPath parametrów parametrów Update-Help DestinationPath lub LiteralPath .Save-Help

Jak zainstalować i zaktualizować pliki pomocy

Aby pobrać i zainstalować pliki pomocy po raz pierwszy lub zaktualizować pliki pomocy na komputerze, użyj Update-Help polecenia cmdlet .

Polecenie Update-Help cmdlet wykonuje całą ciężką pracę, w tym następujące zadania.

  • Określa, które moduły obsługują pomoc z możliwością aktualizacji.
  • Znajduje lokalizację internetową, w której każdy moduł przechowuje jego pliki Pomocy z możliwością aktualizacji.
  • Porównuje pliki pomocy dla każdego modułu na komputerze z najnowszymi plikami pomocy dostępnymi dla każdego modułu.
  • Pobiera nowe pliki z Internetu.
  • Odpakowuje pakiet plików pomocy.
  • Sprawdza, czy pliki są prawidłowymi plikami pomocy.
  • Instaluje pliki pomocy w podkatalogu specyficznym dla języka katalogu modułu.

Aby uzyskać dostęp do nowych tematów pomocy, użyj Get-Help polecenia cmdlet . Nie musisz ponownie uruchamiać programu PowerShell.

Aby zainstalować lub zaktualizować pomoc dotyczącą wszystkich modułów na komputerze obsługującym pomoc z możliwością aktualizacji, wpisz:

Update-Help

Aby zaktualizować pomoc dotyczącą określonych modułów, dodaj parametr Module polecenia Update-Help. Symbole wieloznaczne są dozwolone w nazwie modułu.

Aby na przykład zaktualizować pomoc dotyczącą modułu ServerManager, wpisz:

Update-Help -Module ServerManager

Bez parametrów Update-Help aktualizacje pomocy dla wszystkich modułów w sesji i dla wszystkich zainstalowanych modułów obsługujących pomoc z możliwością aktualizacji. Aby można je było uwzględnić, moduły muszą być zainstalowane w katalogach wymienionych w wartości zmiennej środowiskowej PSModulePath. Są to również moduły zwracane przez Get-Module -ListAvailable polecenie.

Jeśli wartość parametru modułu to * (wszystkie), Update-Help próbuje zaktualizować pomoc dla wszystkich zainstalowanych modułów, w tym moduły, które nie obsługują pomocy możliwej do zaktualizowania. To polecenie zwykle generuje wiele błędów, ponieważ polecenie cmdlet napotyka moduły, które nie obsługują aktualizowalnej pomocy.

Jak zaktualizować pomoc z udziału plików

Aby obsługiwać komputery, które nie są połączone z Internetem, lub kontrolować lub usprawnić aktualizowanie w przedsiębiorstwie, użyj Save-Help polecenia cmdlet . Polecenie Save-Help cmdlet pobiera pliki pomocy z Internetu i zapisuje je w określonym katalogu systemu plików.

Save-Help Porównuje pliki pomocy w określonym katalogu z najnowszymi plikami pomocy dostępnymi dla każdego modułu. Jeśli katalog nie ma plików pomocy lub nowsze pliki pomocy są dostępne dla modułu, Save-Help polecenie cmdlet pobiera nowe pliki z Internetu. Nie można jednak odpakowywać ani instalować plików pomocy.

Aby zainstalować lub zaktualizować pliki pomocy na komputerze z plików pomocy zapisanych w katalogu systemu plików, użyj parametru Update-Help SourcePath polecenia cmdlet. Polecenie Update-Help cmdlet identyfikuje najnowsze pliki pomocy, odpakowuje je i weryfikuje oraz instaluje je w podkatalogach specyficznych dla języka katalogów modułów.

Aby na przykład zapisać pomoc dotyczącą wszystkich zainstalowanych modułów w \\Server\Share katalogu, wpisz:

Save-Help -DestinationPath \\Server\Share

Następnie, aby zaktualizować pomoc z \\Server\Share katalogu, wpisz:

Update-Help -SourcePath \\Server\Share

W poniższych przykładach pokazano użycie polecenia Save-Help w celu zapisania pomocy dla modułów, które nie są zainstalowane na komputerze lokalnym. W tym przykładzie administrator uruchamia polecenie Save-Help zapisywania pomocy dla modułu DhcpServer z komputera klienckiego połączonego z Internetem bez instalowania modułu DhcpServer lub roli serwera DHCP na komputerze lokalnym.

Opcja 1. Uruchom polecenie Invoke-Command , aby pobrać obiekt PSModuleInfo dla modułu zdalnego, zapisać go w zmiennej , $ma następnie uruchomić Save-Help w obiekcie PSModuleInfo, określając zmienną $m jako nazwę modułu.

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

Opcja 2. Otwórz plik PSSession przeznaczony dla komputera z uruchomionym modułem serwera DHCP, aby pobrać obiekt PSModuleInfo dla modułu, zapisać go w zmiennej $m, a następnie uruchomić Save-Help na obiekcie zapisanym w zmiennej $m .

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

Opcja 3. Otwórz sesję modelu CIM, przeznaczoną dla komputera z uruchomionym modułem serwera DHCP, aby pobrać obiekt PSModuleInfo dla modułu, zapisać go w zmiennej $m, a następnie uruchomić Save-Help na obiekcie zapisanym w zmiennej $m .

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

W poniższym przykładzie administrator instaluje pomoc dla modułu serwera DHCP na komputerze, który nie ma dostępu do sieci.

Najpierw uruchom polecenie Export-Clixml , aby wyeksportować obiekt PSModuleInfo do folderu udostępnionego lub nośnika wymiennego.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m

Następnie przetransportuj nośnik wymienny do komputera z dostępem do Internetu, a następnie zaimportuj obiekt PSModuleInfo za pomocą polecenia Import-Clixml. Uruchom polecenie Save-Help , aby zapisać pomoc dla zaimportowanych obiektów PSModuleInfo modułu DhcpServer.

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp

Na koniec przetransportuj nośnik wymienny z powrotem do komputera, który nie ma dostępu do sieci, a następnie zainstaluj pomoc, uruchamiając polecenie Update-Help.

Update-Help -Module DhcpServer -SourcePath E:\UsbDrive\SavedHelp

Bez parametrów Save-Help pobiera pomoc dotyczącą wszystkich modułów w sesji i wszystkich zainstalowanych modułów obsługujących pomoc z możliwością aktualizacji. Aby można je było uwzględnić, moduły muszą być zainstalowane w katalogach wymienionych w wartości $env:PSModulePath zmiennej środowiskowej na komputerze lokalnym lub na komputerze zdalnym, dla którego chcesz zapisać pomoc. Są to również moduły, które są zwracane przez uruchomienie Get-Help -ListAvailable polecenia.

Jak zaktualizować pliki pomocy w różnych językach

Domyślnie Update-Help polecenia cmdlet i Save-Help pobierają pomoc w kulturze i języku interfejsu użytkownika ustawionym dla systemu Windows na komputerze lokalnym. Jeśli pliki pomocy dla określonych modułów nie są dostępne w lokalnej kulturze Update-Help interfejsu użytkownika i Save-Help użyj reguł rezerwowych języka systemu Windows, aby znaleźć najlepszy obsługiwany język.

Można jednak użyć parametrów Update-Help UICulture poleceń cmdlet i Save-Help do pobierania i instalowania plików pomocy w dowolnych kulturach interfejsu użytkownika, w których są dostępne.

Aby na przykład zapisać najnowsze pliki pomocy dla wszystkich modułów w sesji w języku japońskim (ja-Jp) i francuskim (fr-FR), wpisz:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Jeśli pliki pomocy dla modułów nie są dostępne w określonych językach, polecenia cmdlet i Save-Help zwracają komunikat o błędzie z listą języków, w których jest dostępna pomoc dla każdego modułu, Update-Help aby można było wybrać alternatywę, która najlepiej spełnia Twoje potrzeby.

Uwaga

Obecnie zawartość Pomocy z możliwością aktualizacji jest publikowana tylko w języku angielskim (en-US).

Jak używać pomocy online

Jeśli nie możesz lub nie chcesz aktualizować plików pomocy na komputerze lokalnym, nadal możesz uzyskać najnowsze pliki pomocy w trybie online.

Aby otworzyć temat pomocy online dla dowolnego polecenia cmdlet lub funkcji, użyj parametru Get-Help Online polecenia cmdlet.

Na przykład następujące polecenie otwiera temat pomocy online dla Get-Job polecenia cmdlet w domyślnej przeglądarce internetowej:

Get-Help Get-Job -Online

Aby uzyskać pomoc online dotyczącą skryptu, użyj parametru Online i pełnej ścieżki do skryptu.

Parametr Online nie działa z tematami Informacje. Aby zapoznać się z tematami dotyczącymi programu PowerShell, w tym tematami pomocy dotyczącymi języka programu PowerShell, zobacz Tematy dotyczące programu PowerShell — informacje.

Jak zminimalizować lub uniemożliwić pobieranie z Internetu

Aby zminimalizować pobieranie z Internetu i udostępnić użytkownikom, którzy nie są połączeni z Internetem, użyj Save-Help polecenia cmdlet Updatable Help. Pobierz pomoc z Internetu i zapisz ją w udziale sieciowym. Następnie utwórz ustawienie zasad grupy lub zaplanowane zadanie, które uruchamia Update-Help polecenie na wszystkich komputerach. Ustaw wartość parametru Update-Help SourcePath polecenia cmdlet na udział sieciowy.

Aby uniemożliwić użytkownikom, którzy mają dostęp do Internetu, pobierają z Internetu pomoc z możliwością aktualizacji, użyj ustawienia Ustaw domyślną ścieżkę źródłową zasad grupy Update-Help .

To ustawienie zasad grupy niejawnie dodaje parametr SourcePath z wybraną lokalizacją systemu plików do każdego Update-Help polecenia na każdym komputerze, którego dotyczy problem. Użytkownicy mogą jawnie użyć parametru SourcePath, aby określić inną lokalizację systemu plików, ale nie mogą wykluczyć parametru SourcePath i pobrać pomocy z Internetu.

Uwaga

W obszarze Konfiguracja komputera i Konfiguracja użytkownika zostanie wyświetlona domyślna ścieżka źródłowa dla ustawienia zasad grupy Update-Help. Jednak tylko ustawienie zasad w obszarze Konfiguracja komputera jest skuteczne. Ustawienie zasad w obszarze Konfiguracja użytkownika jest ignorowane.

Aby uzyskać więcej informacji, zobacz temat Informacje o ustawieniach zasad grupy.

Jak zaktualizować pomoc dotyczącą modułów innych niż standardowe

Aby zaktualizować lub zapisać pomoc dla modułu, który nie jest zwracany przez parametr ListAvailable polecenia cmdlet, zaimportuj moduł do bieżącej sesji przed uruchomieniem Update-Help polecenia lub Save-Help Get-Module . Na komputerze zdalnym przed uruchomieniem polecenia zaimportuj Save-Help moduł do bieżącej sesji lub Invoke-Command bloku skryptu, który jest połączony z komputerem zdalnym.

Gdy moduł jest w bieżącej sesji, uruchom Update-Help polecenia cmdlet lub Save-Help bez parametrów lub użyj parametru Module , aby określić nazwę modułu.

Parametry modułu Update-Help poleceń cmdlet i Save-Help akceptują tylko nazwę modułu. Nie akceptują ścieżki do pliku modułu.

Ta technika służy do aktualizowania lub zapisywania pomocy dla każdego modułu, który nie jest zwracany przez parametr ListAvailable polecenia cmdlet, na przykład moduł zainstalowany w lokalizacji, która nie znajduje się w $env:PSModulePath zmiennej środowiskowej, lub modułu, który nie jest poprawnie sformułowany (katalog modułu nie zawiera co najmniej jednego pliku, którego nazwa podstawowa jest taka sama Get-Module jak nazwa katalogu).

Jak obsługiwać pomoc z możliwością aktualizacji

Jeśli tworzysz moduł, możesz obsługiwać pomoc online i aktualizowalną pomoc dla modułów. Aby uzyskać więcej informacji, zobacz Obsługa aktualizowalnej pomocy i obsługi pomocy online.

Aktualizowalna pomoc nie jest dostępna dla przystawek programu PowerShell ani pomocy opartej na komentarzach.

Uwagi

Polecenia Update-Help cmdlet i Save-Help nie są obsługiwane w środowisku preinstalacji systemu Windows (Windows PE).

Zobacz też