Informacje o aktualizowalnej pomocy
KRÓTKI OPIS
Opisuje aktualizowalny system pomocy w programie PowerShell.
DŁUGI OPIS
Program PowerShell oferuje 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, jest przeznaczony do zapewnienia, że zawsze masz najnowsze tematy pomocy na komputerze lokalnym, aby można było je odczytać w wierszu polecenia. Ułatwia pobieranie i instalowanie plików pomocy oraz aktualizowanie ich przy każdym udostępnieniu nowszych plików pomocy.
Aby zapewnić zaktualizowaną pomoc dla wielu komputerów w przedsiębiorstwie i dla komputerów, które nie mają dostępu do Internetu, można aktualizować Pomoc umożliwia pobieranie plików pomocy do katalogu systemu plików lub udziału plików, a następnie instalowanie plików pomocy z udziału plików.
W programie PowerShell 4.0 właściwość HelpInfoUri jest zachowywana za pośrednictwem komunikacji zdalnej Windows PowerShell, co pozwala Save-Help pracować dla modułów zainstalowanych na komputerze zdalnym, ale niekoniecznie są zainstalowane na komputerze lokalnym. Obiekt PSModuleInfo można zapisać na dysku lub nośniku wymiennym (takim jak dysk USB), uruchamiając Export-Clixml 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 uruchamiając 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 bez jakiegokolwiek dostępu do sieci. Aby zapoznać się z przykładem korzystania z nowej funkcji Save-Help, zobacz "HOW TO UPDATE HELP FROM A FILE SHARE: SAVE-HELP" (JAK ZAKTUALIZOWAĆ POMOC DOTYCZĄCĄ UDZIAŁU PLIKÓW: SAVE-HELP) w tym temacie.
Aktualizowalna pomoc obsługuje również dostęp online do najnowszych tematów pomocy i podstawową pomoc dla poleceń cmdlet, nawet jeśli na komputerze nie ma żadnych plików pomocy.
Program PowerShell 3.0 nie jest wyposażony w pliki Pomocy. Za pomocą funkcji Updatable Help można zainstalować pliki pomocy dla wszystkich poleceń dołączonych domyślnie w programie PowerShell i dla wszystkich modułów systemu Windows.
POLECENIA CMDLET POMOCY Z MOŻLIWOŚCIĄ AKTUALIZOWANIA
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.
AKTUALIZACJA POMOCY W PROGRAMIE PowerShell ISE
Pomoc można również zaktualizować przy użyciu elementu "Aktualizowanie pomocy programu PowerShell" w menu Pomoc w środowisku zintegrowanego skryptów programu PowerShell (ISE).
Element "Aktualizowanie pomocy programu PowerShell" uruchamia polecenie Update-Help bez parametrów.
AUTOMATYCZNIE WYGENEROWANA POMOC: POMOC BEZ PLIKÓW POMOCY
Jeśli nie masz pliku pomocy dla polecenia cmdlet, funkcji lub przepływu pracy na komputerze, polecenie cmdlet Get-Help 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ą polecenia cmdlet Get-Culture. Dane wyjściowe pokazują Get-Help wyświetlane, 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
Najmniejsza jednostka aktualizowalnej pomocy to pomoc dla modułu. Pomoc modułu zawiera pomoc dotyczącą 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 dla 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 polecenie cmdlet Set-ExecutionPolicy, 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 w bibliotece TechNet.
Aktualizowanie pomocy dla modułów w katalogu $home\Documents\WindowsPowerShell\Modules lub modułach w innych podkatalogach katalogu $home nie wymagają specjalnych uprawnień.
Polecenia cmdlet Update-Help 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 cmdlet Update-Help i Save-Help również mają parametr Credential, który umożliwia uruchamianie polecenia na komputerze zdalnym i uzyskiwanie dostępu do udziału plików na komputerze trzecim. Parametr Credential jest prawidłowy tylko wtedy, gdy używasz parametrów SourcePath lub LiteralPath Update-Help oraz parametrów DestinationPath lub LiteralPath polecenia 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 polecenia cmdlet Update-Help.
Polecenie cmdlet Update-Help wykonuje całą ciężką pracę, w tym następujące zadania.
- Określa, które moduły obsługują aktualizowalną pomoc.
- Znajduje lokalizację internetową, w której każdy moduł przechowuje jego pliki Pomocy z możliwością aktualizowania.
- 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 polecenia cmdlet Get-Help. Nie trzeba ponownie uruchamiać programu PowerShell.
Aby zainstalować lub zaktualizować pomoc dla wszystkich modułów na komputerze, który obsługuje aktualizowalną Pomoc, wpisz:
Update-Help
Aby zaktualizować pomoc dotyczącą określonych modułów, dodaj parametr Modułu Pomocy aktualizacji. Symbole wieloznaczne są dozwolone w nazwie modułu.
Aby na przykład zaktualizować pomoc dla modułu ServerManager, wpisz:
Update-Help -Module ServerManager
Bez parametrów Update-Help pomoc dotycząca aktualizacji dla wszystkich modułów w sesji i dla wszystkich zainstalowanych modułów, które obsługują aktualizowalną pomoc. 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, które są zwracane przez polecenie "Get-Help -ListAvailable".
Jeśli wartość parametru Moduł to * (wszystkie), Update-Help próbuje zaktualizować pomoc dla wszystkich zainstalowanych modułów, w tym modułów, które nie obsługują aktualizowalnej pomocy. 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: SAVE-HELP
Aby obsługiwać komputery, które nie są połączone z Internetem, lub kontrolować lub usprawniać aktualizowanie w przedsiębiorstwie, użyj polecenia cmdlet Save-Help. Polecenie cmdlet Save-Help 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, polecenie cmdlet Save-Help 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 SourcePath polecenia cmdlet Update-Help. Polecenie cmdlet Update-Help 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 dla wszystkich zainstalowanych modułów w katalogu \\Server\Share, wpisz:
Save-Help -DestinationPath \\Server\Share
Następnie, aby zaktualizować pomoc z katalogu \\Server\Share, wpisz:
Update-Help -SourcePath \\Server\Share
W poniższych przykładach pokazano użycie Save-Help w celu zapisania pomocy dla modułów, które nie są zainstalowane na komputerze lokalnym. W tym przykładzie administrator uruchamia Save-Help, aby zapisać pomoc 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 Invoke-Command, aby pobrać obiekt PSModuleInfo dla modułu zdalnego, zapisać go w zmiennej, $m, a następnie uruchomić Save-Help w obiekcie PSModuleInfo, określając zmienną $m jako nazwę modułu.
$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
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ę 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 Export-Clixml, aby wyeksportować obiekt PSModuleInfo do folderu udostępnionego lub nośnika wymiennego.
$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbFlashDrive\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 Save-Help, aby zapisać pomoc dla zaimportowanych obiektów PSModuleInfo modułu DhcpServer.
$deserialized_m = Import-Clixml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath `
E:\UsbFlashDrive\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:\UsbFlashDrive\SavedHelp
Bez parametrów Save-Help pobrać pomoc dla wszystkich modułów w sesji i dla wszystkich zainstalowanych modułów, które obsługują aktualizowalną Pomoc. Aby można je było uwzględnić, moduły muszą być zainstalowane w katalogach wymienionych w wartości zmiennej środowiskowej PSModulePath 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 polecenia "Get-Help -ListAvailable".
JAK ZAKTUALIZOWAĆ PLIKI POMOCY W RÓŻNYCH JĘZYKACH
Domyślnie polecenia cmdlet Update-Help i Save-Help pobierają pomoc dotyczącą kultury i języka interfejsu użytkownika ustawionego dla systemu Windows na komputerze lokalnym. Jeśli pliki pomocy dla określonych modułów nie są dostępne w lokalnej kulturze interfejsu użytkownika, Update-Help 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 UICulture poleceń cmdlet Update-Help i Save-Help, aby pobrać i zainstalować pliki 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, Update-Help i Save-Help polecenia cmdlet zwracają komunikat o błędzie z listą języków, w których jest dostępna pomoc dla każdego modułu, dzięki czemu można wybrać alternatywę, która najlepiej odpowiada Twoim potrzebom.
JAK AUTOMATYCZNIE AKTUALIZOWAĆ POMOC
Aby mieć pewność, że zawsze masz najnowsze pliki pomocy, możesz dodać polecenie Update-Help do profilu programu PowerShell.
Wewnętrzny limit przydziału uniemożliwia uruchamianie polecenia Update-Help więcej niż raz dziennie. Aby zastąpić wartość maksymalną raz dziennie, użyj parametru Force.
Użyj polecenia podobnego do poniższego w profilu. To polecenie aktualizuje pomoc dla wszystkich zainstalowanych modułów w zadaniu w tle, dzięki czemu nie zakłóca pracy. Używa polecenia Out-Null, aby pominąć zwracane zadanie i wszelkie komunikaty o błędach, które w przeciwnym razie będą wyświetlane, gdy używasz polecenia więcej niż raz dziennie.
Start-Job {Update-Help} | Out-Null
Można również utworzyć zaplanowane zadanie uruchamiające polecenie cmdlet Update-Help lub Save-Help w dowolnym interwale.
Na przykład następujące polecenie tworzy zaplanowane zadanie, które uruchamia polecenie pomocy Update-Help co piątek o 5:00. Aby uruchomić to polecenie, uruchom program PowerShell z opcją "Uruchom jako administrator".
Register-ScheduledJob -Name UpdateHelpJob -ScriptBlock {Update-Help} `
-Trigger (New-JobTrigger -Weekly -DaysOfWeek Friday -At "5:00 AM")
JAK KORZYSTAĆ Z POMOCY ONLINE
Jeśli nie możesz lub nie chcesz aktualizować plików pomocy na komputerze lokalnym, nadal możesz pobrać najnowsze pliki pomocy w trybie online.
Aby otworzyć temat pomocy online dla dowolnego polecenia cmdlet lub funkcji, użyj parametru Online polecenia cmdlet Get-Help.
Na przykład następujące polecenie otwiera temat pomocy online dla polecenia cmdlet Get-Job w domyślnej przeglądarce internetowej:
Get-Help Get-Job -Online
Aby uzyskać pomoc online dla skryptu, użyj parametru Online i pełnej ścieżki do skryptu.
Parametr Online nie działa z tematami About (Informacje). Aby zapoznać się z tematami dotyczącymi programu PowerShell Core, w tym tematami pomocy dotyczącymi języka programu PowerShell, zobacz PowerShell Core Module About Topics (Podstawowe tematy dotyczące modułów programu PowerShell).
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 polecenia cmdlet Save-Help. Pobierz pomoc z Internetu i zapisz ją w udziale sieciowym. Następnie utwórz ustawienie zasady grupy lub zaplanowane zadanie, które uruchamia Update-Help polecenia na wszystkich komputerach. Ustaw wartość parametru SourcePath polecenia cmdlet Update-Help na udział sieciowy.
Aby uniemożliwić użytkownikom mającym dostęp do Internetu pobieranie aktualizowalnej pomocy z Internetu, użyj ustawienia "Ustaw domyślną ścieżkę źródłową Dla pomocy aktualizacji" zasady grupy.
To ustawienie zasady grupy niejawnie dodaje parametr SourcePath z wybraną lokalizacją systemu plików do każdego polecenia Update-Help 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: Ustawienie zasad grupy "Ustaw domyślną ścieżkę źródłową dla Pomocy aktualizacji" jest wyświetlane w obszarze Konfiguracja komputera i Konfiguracja użytkownika. 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 about_Group_Policy_Settings.
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 Get-Module, zaimportuj moduł do bieżącej sesji przed uruchomieniem polecenia Update-Help lub Save-Help. Na komputerze zdalnym przed uruchomieniem polecenia Save-Help zaimportuj moduł do bieżącego modułu CIM lub PSSession —lub Invoke-Command bloku skryptu — który jest połączony z komputerem zdalnym.
Gdy moduł znajduje się w bieżącej sesji, uruchom Update-Help lub Save-Help polecenia cmdlet bez parametrów lub użyj parametru Module, aby określić nazwę modułu.
Parametry modułu poleceń cmdlet Update-Help 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 Get-Module, takiego jak moduł zainstalowany w lokalizacji, która nie znajduje się na liście w zmiennej środowiskowej PSModulePath 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 jak nazwa katalogu).
JAK OBSŁUGIWAĆ POMOC AKTUALIZOWALNĄ
Jeśli tworzysz moduł, możesz obsługiwać pomoc online i aktualizowalną pomoc dotyczącą modułów. Aby uzyskać więcej informacji, zobacz "Obsługa aktualizowalnej pomocy" i Obsługa pomocy online w Microsoft Docs.
Aktualizowalna pomoc nie jest dostępna dla przystawek programu PowerShell lub pomocy opartej na komentarzach.
UWAGI
Polecenia cmdlet Update-Help i Save-Help nie są obsługiwane w środowisku preinstalacji systemu Windows (Windows PE).