about_Updatable_Help

  • Artikel

Kort beskrivning

Beskriver det uppdaterade hjälpsystemet i PowerShell.

Lång beskrivning

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

Updatable-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å din lokala dator 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 med updatable-hjälpen ladda ned hjälpfiler till en filsystemkatalog eller filresurs och sedan installera hjälpfilerna från filresursen.

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

Updatable Help stöder även onlineåtkomst till de senaste hjälpämnena och grundläggande hjälp för cmdletar, även om det inte finns några hjälpfiler på datorn.

PowerShell levereras inte med hjälpfiler. Du kan använda funktionen Updatable Help för att installera hjälpfilerna för alla kommandon som ingår som standard i PowerShell och för alla Windows-moduler.

Cmdletar för uppdateringsbar hjälp

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

  • Save-Help: Laddar ned de senaste hjälpfilerna från Internet och sparar dem i en filsystemkatalog 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 cmdletar och funktioner som inte har hjälpfiler. Öppnar onlinehjälpavsnitt för cmdletar, funktioner, skript och arbetsflöden i din standardwebbläsare.

Hjälp som genereras automatiskt: hjälp utan hjälpfiler

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

Automatisk genererad hjälp innehåller syntax och alias samt kommentarer som förklarar hur du använder cmdletar för updatable-hjälp och för att få åtkomst till onlinehjälpavsnitten.

Följande kommando får till exempel grundläggande hjälp för cmdleten Get-Culture . 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 i Updatable Help är hjälp för en modul. Modulhjälpen innehåller hjälp för alla cmdletar, funktioner, arbetsflöden, leverantörer, skript och begrepp i en modul. Du kan uppdatera hjälpen för alla moduler som är installerade på datorn, även om de inte importeras till den aktuella sessionen.

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

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 cmdleten Set-ExecutionPolicy 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 cmdleten Set-ExecutionPolicy skriver du:

Update-Help -Module Microsoft.PowerShell.Security

Behörigheter för uppdaterad hjälp

Om du vill uppdatera hjälpen för modulerna i katalogen $pshome/Modulesmå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 dessa moduler. men om du har internetåtkomst kan du visa hjälp online.

Att uppdatera hjälpen för moduler i katalogen $HOME/Documents/PowerShell/Modules eller modulerna i andra underkataloger i $HOME katalogen kräver inte särskilda behörigheter.

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

Update-Help Cmdletarna och Save-Help har också en parameter för autentiseringsuppgifter 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 parametrarna Update-Help SourcePath eller LiteralPath och 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 cmdleten Update-Help .

Cmdleten Update-Help utför allt hårt arbete åt dig, inklusive följande uppgifter.

  • Avgör vilka moduler som stöder uppdateringsbar hjälp.
  • Hittar den internetplats där varje modul lagrar sina Updatable Help-filer.
  • 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.
  • Packar upp hjälpfilspaketet.
  • Verifierar att filerna är giltiga hjälpfiler.
  • Installerar hjälpfilerna i modulkatalogens språkspecifika underkatalog.

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

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

Update-Help

Om du vill uppdatera hjälpen för vissa moduler lägger du till modulparametern Update-Helpför . 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 Update-Help hjälper uppdateringar 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 också moduler som returneras av ett Get-Module -ListAvailable kommando.

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

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

Använd cmdleten Save-Help för att stödja datorer som inte är anslutna till Internet eller för att styra eller effektivisera uppdatering i ett företag. Cmdleten Save-Help laddar ned hjälpfiler från Internet och sparar dem i en filsystemkatalog 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 nyare hjälpfiler är tillgängliga för modulen hämtar cmdleten Save-Help de nya filerna från Internet. Den löser dock inte upp eller installerar inte hjälpfilerna.

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 cmdleten Update-Help . Cmdleten Update-Help identifierar de senaste hjälpfilerna, skriver upp och validerar dem och installerar dem i de språkspecifika underkatalogerna för modulkatalogerna.

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

Save-Help -DestinationPath \\Server\Share

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

Update-Help -SourcePath \\Server\Share

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

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

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

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

$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, riktad mot datorn som kör DHCP Server-modulen, för att hämta PSModuleInfo-objektet för modulen, spara det i en variabel $moch kör Save-Help sedan på objektet som sparas i variabeln $m .

$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 Server-modulen på en dator som inte har nätverksåtkomst.

Export-Clixml Kör först för att exportera PSModuleInfo-objektet till en delad mapp eller till flyttbara medier.

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

Sedan 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 PSModuleInfo-modulobjektet för DhcpServer-modulen.

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

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

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

Utan parametrar Save-Help hjälper nedladdningar till 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 $env:PSModulePath för miljövariabeln, antingen på den lokala datorn eller på en fjärrdator som du vill spara hjälp för. Det här är också 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 Update-Help hämtar cmdletarna och Save-Help hjälpen i användargränssnittskulturen och språket som har angetts för Windows på den lokala datorn. Om hjälpfilerna för de angivna modulerna inte är tillgängliga i den lokala användargränssnittskulturen Update-Help och Save-Help använder reservreglerna för Windows-språk för att hitta det språk som stöds bäst.

Du kan dock använda UICulture-parametrarnaUpdate-Help för cmdletarna och Save-Help för att ladda ned och installera hjälpfiler i alla användargränssnittskulturer 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 angav Update-Help returnerar cmdletarna och Save-Help ett felmeddelande som visar de språk där hjälp för varje modul är tillgänglig så att du kan välja det alternativ som bäst uppfyller dina behov.

Kommentar

För närvarande publiceras uppdateringsbart hjälpinnehåll endast på engelska (en-US).

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

Om du inte kan eller väljer att inte uppdatera hjälpfilerna på den lokala datorn kan du fortfarande få de senaste hjälpfilerna online.

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

Följande kommando öppnar till exempel onlinehjälpavsnittet för cmdleten Get-Job 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. Mer information om ämnen för PowerShell, inklusive hjälpavsnitt om PowerShell-språket, finns i Avsnittet om PowerShell.

Så här minimerar eller förhindrar du nedladdningar på Internet

Om du vill minimera internetnedladdningar och ge uppdaterad hjälp till användare som inte är anslutna till Internet använder du cmdleten Save-Help . Ladda ned hjälp från Internet och spara den i en nätverksresurs. Skapa sedan en grupprincipinställning eller ett schemalagt jobb som kör ett Update-Help kommando på alla datorer. Ange värdet för sourcepath-parametern för cmdleten Update-Help till nätverksresursen.

Om du vill förhindra att användare som har internetåtkomst laddar ned Updatable-hjälpen från Internet använder du inställningen Ange standardsökväg för grupprincip för uppdateringshjälp .

Den här grupprincipinställningen lägger implicit till parametern SourcePath , med den filsystemplats som du anger, till varje Update-Help kommando på varje berörd dator. Användare kan använda SourcePath-parametern explicit för att ange en annan filsystemplats, men de kan inte exkludera SourcePath-parametern och hämta hjälp från Internet.

Kommentar

Inställningen Ange standardkällans sökväg för grupprincipinställningen Uppdatera hjälp visas under Datorkonfiguration och Användarkonfiguration. Det är dock bara principinställningen under Datorkonfiguration som gäller. Principinställningen under Användarkonfiguration ignoreras.

Mer information finns i about_Group_Policy_Settings.

Så här uppdaterar du hjälpen för moduler som inte är standard

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

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

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

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

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

Om du skapar en modul kan du stödja onlinehjälp och uppdaterad hjälp för dina moduler. Mer information finns i Support Updatable Help and Supporting Online Help (Support Updatable Help and Supporting Online Help).

Uppdateringsbar hjälp är inte tillgänglig för PowerShell-snapin-moduler eller kommentarsbaserad hjälp.

Kommentarer

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

Se även