about_Updatable_Help

Kort beskrivning

Beskriver det uppdaterbara hjälpsystemet i PowerShell.

Lång beskrivning

PowerShell erbjuder flera olika sätt att komma åt de senaste hjälpavsnitten för PowerShell-cmdlets och begrepp.

Det uppdatbara hjälpsystemet, som introducerades i PowerShell 3.0, är utformat för att säkerställa att du alltid har de senaste hjälpavsnitten på den lokala datorn så att du kan läsa dem på kommandoraden. Det gör det enkelt att ladda ned och installera hjälpfiler och uppdatera dem när nyare hjälpfiler blir tillgängliga.

Om du vill ge uppdaterad hjälp för flera datorer i ett företag och för datorer som inte har åtkomst till Internet, kan du ladda ned hjälpfiler till en filsystemskatalog eller filresurs och sedan installera hjälpfilerna från filresursen.

I PowerShell 4.0 bevaras egenskapen HelpInfoUri över Windows PowerShell-fjärrkommunikation, vilket gör det möjligt att arbeta för moduler som är installerade på en fjärrdator, men som inte nödvändigtvis är installerade på den Save-Help lokala datorn. Du kan spara ett PSModuleInfo-objekt på disk eller flyttbart medium (till exempel en USB-enhet) genom att köra på en dator som inte har Internetåtkomst, importera PSModuleInfo-objektet på en dator som har Internetåtkomst och sedan köra på Export-Clixml Save-Help PSModuleInfo-objektet. Den sparade hjälpen kan kopieras till den fjärranslutna, frånkopplade datorn med hjälp av flyttbara media och sedan installeras genom att köra Update-Help . Med de här Save-Help funktionsförbättringarna kan du installera hjälp på datorer som saknar någon typ av nätverksåtkomst. Ett exempel på hur du använder de nya funktionerna finns i Så här Save-Help uppdaterar du hjälpen från en filresurs i det här avsnittet.

Uppdaterbar hjälp har även stöd för onlineåtkomst till de senaste hjälpavsnitten och grundläggande hjälp för cmdlets, även om det inte finns några hjälpfiler på datorn.

PowerShell 3.0 innehåller inte hjälpfiler. Du kan använda funktionen Uppdatabel hjälp för att installera hjälpfilerna för alla kommandon som ingår som standard i PowerShell och för alla Windows moduler.

Cmdlets för uppdaterbar hjälp

• Update-Help: Hämtar de senaste hjälpfilerna från Internet eller en filresurs och installerar dem på den lokala datorn.

• Save-Help: Hämtar de senaste hjälpfilerna från Internet och sparar dem i en filsystemskatalog eller filresurs. Om du vill installera hjälpfilerna på datorer använder du Update-Help .

• Get-Help: Visar hjälpavsnitt på kommandoraden. Får hjälp från hjälpfilerna på datorn. Visar automatiskt genererad hjälp för cmdlets och funktioner som inte har hjälpfiler. Öppnar onlinehjälpavsnitt för cmdlets, funktioner, skript och arbetsflöden i din standardwebbläsare.

Automatiskt genererad hjälp: hjälp utan hjälpfiler

Om du inte har hjälpfilen för en cmdlet, funktion eller ett arbetsflöde på datorn visar cmdleten automatiskt genererad hjälp och uppmanar dig att ladda ned hjälpfilerna eller läsa Get-Help dem online.

Den automatiskt genererade hjälpen innehåller syntax och alias, samt kommentarer som förklarar hur du använder cmdlets för uppdaterbar hjälp och för att få åtkomst till onlinehjälpavsnitten.

Följande kommando hämtar till exempel grundläggande hjälp för Get-Culture cmdleten . Utdata visar Get-Help visningen när det inte finns några hjälpfiler på datorn.

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.

Hjälpfiler för moduler

Den minsta enheten för uppdatabel hjälp är hjälp för en modul. Modulhjälpen innehåller hjälp för alla cmdlets, funktioner, arbetsflöden, providers, skript och begrepp i en modul. Du kan uppdatera hjälpen för alla moduler som är installerade på datorn, även om de inte har importerats till den aktuella sessionen.

Du kan uppdatera hjälpen för hela modulen, men du kan inte uppdatera hjälpen för enskilda cmdlets.

Använd följande kommandoformat för att hitta modulen som innehåller en viss cmdlet:

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

Om du till exempel vill hitta modulen som innehåller Set-ExecutionPolicy cmdleten skriver du:

(Get-Command Set-ExecutionPolicy).ModuleName

Om du vill uppdatera hjälpen för en viss modul skriver du:

Update-Help -Module <ModuleName>

Om du till exempel vill uppdatera hjälpen för modulen som innehåller Set-ExecutionPolicy cmdlet skriver du:

Update-Help -Module Microsoft.PowerShell.Security

Behörigheter för uppdatabel hjälp

Om du vill uppdatera hjälpen för modulerna i $pshome/Modules katalogen måste du vara medlem i gruppen Administratörer på datorn.

Om du inte är medlem i gruppen Administratörer kan du inte uppdatera hjälpen för de här modulerna. men om du har Internetåtkomst kan du visa hjälp online.

Uppdatering av hjälp för moduler i $home/Documents/PowerShell/Modules katalogen eller moduler i andra underkataloger i katalogen kräver inte särskilda $home behörigheter.

Update-Help Save-Help Cmdletarna och har en UseDefaultCredentials-parameter som tillhandahåller explicita autentiseringsuppgifter för den aktuella användaren. Den här parametern är utformad för åtkomst till säkra Internetplatser.

Cmdletarna och har också en Update-Help Save-Help credential-parameter som gör att du kan köra kommandot på en fjärrdator och komma åt en filresurs på en tredje dator. Parametern Credential är endast giltig när du använder SourcePath- eller LiteralPath-parametrarna för och Update-Help parametrarna DestinationPath eller LiteralPath för Save-Help .

Installera och uppdatera hjälpfiler

Om du vill ladda ned och installera hjälpfiler för första gången, eller uppdatera hjälpfilerna på datorn, använder du Update-Help cmdleten .

Update-HelpCmdleten gör allt det svåra arbetet åt dig, inklusive följande uppgifter.

• Avgör vilka moduler som stöder uppdatabel hjälp.
• Söker efter den Internetplats där varje modul lagrar sina uppdaterbara hjälpfiler.
• Jämför hjälpfilerna för varje modul på datorn med de senaste hjälpfilerna som är tillgängliga för varje modul.
• Laddar ned de nya filerna från Internet.
• Packa upp hjälpfilpaketet.
• Verifierar att filerna är giltiga hjälpfiler.
• Installerar hjälpfilerna i den språkspecifika underkatalogen i modulkatalogen.

Om du vill komma åt de nya hjälpavsnitten använder Get-Help du cmdleten . Du behöver inte starta om PowerShell.

Om du vill installera eller uppdatera hjälpen för alla moduler på datorn som stöder uppdateringsbar hjälp skriver du:

Update-Help

Om du vill uppdatera hjälpen för vissa moduler lägger du till modulparametern för Update-Help . Jokertecken tillåts i modulnamnet.

Om du till exempel vill uppdatera hjälpen för ServerManager-modulen skriver du:

Update-Help -Module ServerManager

Utan parametrar uppdaterar Update-Help uppdateringshjälpen för alla moduler i sessionen och för alla installerade moduler som stöder uppdateringsbar hjälp. För att inkluderas måste moduler installeras i kataloger som anges i värdet för miljövariabeln PSModulePath. Det här är även moduler som returneras av kommandot "Get-Help -ListAvailable".

Om värdet för modulparametern är (alla) försöker uppdatera hjälpen för alla installerade moduler, inklusive moduler som inte stöder * Update-Help uppdateringsbar hjälp. Det här kommandot genererar vanligtvis många fel eftersom cmdleten påträffar moduler som inte stöder uppdaterbar hjälp.

Så här uppdaterar du hjälpen från en filresurs

Om du vill ha stöd för datorer som inte är anslutna till Internet, eller för att styra eller effektivisera hjälpuppdateringen i ett företag, använder du Save-Help cmdleten . Save-HelpCmdleten laddar ned hjälpfiler från Internet och sparar dem i en filsystemskatalog som du anger.

Save-Help jämför hjälpfilerna i den angivna katalogen med de senaste hjälpfilerna som är tillgängliga för varje modul. Om katalogen inte har några hjälpfiler eller om nyare hjälpfiler är tillgängliga för modulen laddar Save-Help cmdleten ned de nya filerna från Internet. Däremot packas inte hjälpfilerna upp eller installeras.

Om du vill installera eller uppdatera hjälpfilerna på en dator från hjälpfiler som har sparats i en filsystemkatalog använder du parametern SourcePath för Update-Help cmdleten . Cmdleten identifierar de senaste hjälpfilerna, delar upp och verifierar dem och installerar dem i de språkspecifika underkatalogerna i Update-Help modulkatalogerna.

Om du till exempel vill spara hjälpen för alla installerade moduler i \\Server\Share katalogen skriver du:

Save-Help -DestinationPath \\Server\Share

Om du sedan vill uppdatera hjälpen från \\Server\Share katalogen skriver du:

Update-Help -SourcePath \\Server\Share

I följande exempel visas hur du kan Save-Help spara hjälpen för moduler som inte är installerade på den lokala datorn. I det här exemplet kör administratören för att spara hjälpen för DhcpServer-modulen från en Internetansluten klientdator, utan att installera Save-Help DhcpServer-modulen eller DHCP-serverrollen på den lokala datorn.

Alternativ 1: Kör för att hämta PSModuleInfo-objektet för fjärrmodulen, spara det i en variabel och kör sedan på Invoke-Command $m Save-Help PSModuleInfo-objektet genom att ange variabeln som $m modulnamn.

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

Alternativ 2: Öppna en PSSession riktad mot datorn som kör DHCP-servermodulen för att hämta PSModuleInfo-objektet för modulen, spara den i en variabel och kör sedan på objektet som sparas i $m Save-Help $m variabeln.

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

Alternativ 3: Öppna en CIM-session som är riktad mot datorn som kör DHCP-servermodulen för att hämta PSModuleInfo-objektet för modulen, spara den i en variabel och kör sedan på objektet som sparas i $m Save-Help $m variabeln.

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

I följande exempel installerar administratören hjälp för DHCP-servermodulen på en dator som inte har nätverksåtkomst.

Kör först för Export-Clixml att exportera PSModuleInfo-objektet till en delad mapp eller till ett flyttbart medium.

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

Därefter transporterar du det flyttbara mediet till en dator som har Internetåtkomst och importerar sedan PSModuleInfo-objektet med Import-Clixml . Kör Save-Help för att spara hjälpen för det importerade DhcpServer-modulen PSModuleInfo-objekt.

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

Slutligen transporterar du tillbaka det flyttbara mediet till den dator som inte har nätverksåtkomst och installerar sedan hjälpen genom att köra Update-Help .

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

Utan parametrar hämtar Save-Help hjälpen för alla moduler i sessionen och för alla installerade moduler som stöder uppdaterbar hjälp. Moduler måste installeras i kataloger som anges i värdet för miljövariabeln, antingen på den lokala datorn eller på en fjärrdator som du vill spara hjälpen $env:PSModulePath för. Det här är även moduler som returneras genom att köra ett Get-Help -ListAvailable kommando.

Så här uppdaterar du hjälpfiler på olika språk

Som standard laddar Update-Help cmdletarna och ned hjälp i ui-kulturen och det språk som Save-Help är Windows på den lokala datorn. Om hjälpfilerna för de angivna modulerna inte är tillgängliga i den lokala ui-kulturen och använder Windows för att hitta det språk som Update-Help Save-Help stöds bäst.

Du kan dock använda UICulture-parametrarna för cmdletarna och för att ladda ned och installera hjälpfiler i alla Update-Help Save-Help UI-kulturer där de är tillgängliga.

Om du till exempel vill spara de senaste hjälpfilerna för alla moduler i sessionen på japanska (Ja-jp) och franska (fr-FR) skriver du:

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

Om hjälpfilerna för modulerna inte är tillgängliga på de språk som du har angett returnerar Update-Help cmdletarna och ett felmeddelande som visar de språk där hjälpen för varje modul är tillgänglig så att du kan välja det alternativ som bäst uppfyller Save-Help dina behov.

Så här använder du onlinehjälp

Om du inte kan eller väljer att inte uppdatera hjälpfilerna på din lokala dator kan du fortfarande hämta de senaste hjälpfilerna online.

Om du vill öppna onlinehjälpavsnittet för en cmdlet eller funktion använder du parametern Online för Get-Help cmdleten .

Följande kommando öppnar till exempel onlinehjälpavsnittet för Get-Job cmdleten i din standardwebbläsare:

Get-Help Get-Job -Online

Om du vill få onlinehjälp för ett skript använder du parametern Online och den fullständiga sökvägen till skriptet.

Parametern Online fungerar inte med Om-ämnen. Information om powershell-ämnen, inklusive hjälpavsnitt om PowerShell-språket, finns i PowerShell Om ämnen.

Så här minimerar eller förhindrar du nedladdning från Internet

Använd cmdleten för att minimera internetnedladdningar och ge uppdaterbar hjälp till användare som inte är Save-Help anslutna till Internet. Ladda ned hjälp från Internet och spara den på en nätverksresurs. Skapa sedan en grupprincip eller ett schemalagt jobb som kör Update-Help ett kommando på alla datorer. Ange värdet för parametern SourcePath för Update-Help cmdleten till nätverksresursen.

Om du vill förhindra användare som har Internetåtkomst från att ladda ned Uppdateringsbar hjälp från Internet använder du inställningen Ange standardsökväg för Grupprincip uppdateringshjälp.

Den grupprincip här inställningen lägger implicit till parametern SourcePath, med den filsystemsplats som du anger, till varje kommando Update-Help på varje berörd dator. Användare kan använda sourcepath-parametern explicit för att ange en annan plats för filsystemet, men de kan inte undanta parametern SourcePath och ladda ned hjälp från Internet.

Mer information finns i about_Group_Policy_Settings.

Så här uppdaterar du hjälpen för icke-standardmoduler

Om du vill uppdatera eller spara hjälpen för en modul som inte returneras av parametern ListAvailable för cmdleten importerar du modulen till den aktuella sessionen innan du kör ett Get-Module - eller Update-Help Save-Help -kommando. Innan du kör kommandot på en fjärrdator importerar du modulen till den aktuella sessionen, eller skriptblocket, som Save-Help Invoke-Command är anslutet till fjärrdatorn.

När modulen är i den aktuella sessionen kör du cmdletarna eller utan parametrar eller använder Update-Help Save-Help parametern Modul för att ange modulnamnet.

Modulparametrarna för Update-Help Save-Help cmdletarna och accepterar bara ett modulnamn. De accepterar inte sökvägen till en modulfil.

Använd den här metoden för att uppdatera eller spara hjälpen för alla moduler som inte returneras av parametern ListAvailable för cmdleten, till exempel en modul som är installerad på en plats som inte finns med i miljövariabeln eller en modul som inte är väl utformad (modulkatalogen innehåller inte minst en fil vars basnamn är samma som Get-Module $env:PSModulePath katalognamnet).

Så här stöder du uppdatabel hjälp

Om du skapar en modul kan du stödja onlinehjälp och uppdatabel hjälp för dina moduler. Mer information finns i Stöd för uppdatabel hjälp och support onlinehjälp i Microsoft Docs.

Uppdaterbar hjälp är inte tillgänglig för PowerShell-snapin-modulen eller kommentarsbaserad hjälp.

Kommentarer

Cmdletarna och Update-Help stöds inte i Windows Save-Help Preinstallation Environment (Windows PE).

Se även

Få hjälp

Spara hjälp

Uppdatera hjälp