Get-Help

Referens

Modul:: Microsoft.PowerShell.Core

Visar information om PowerShell-kommandon och begrepp.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

Cmdleten Get-Help visar information om PowerShell-begrepp och -kommandon, inklusive cmdletar, funktioner, CIM-kommandon (Common Information Model), arbetsflöden, leverantörer, alias och skript.

Om du vill få hjälp med en PowerShell-cmdlet skriver Get-Help du följt av cmdlet-namnet, till exempel: Get-Help Get-Process.

Konceptuella hjälpartiklar i PowerShell börjar med about_, till exempel about_Comparison_Operators. Om du vill se alla about_ artiklar skriver du Get-Help about_*. Om du vill se en viss artikel skriver du Get-Help about_<article-name>, till exempel Get-Help about_Comparison_Operators.

Om du vill få hjälp för en PowerShell-provider skriver Get-Help du följt av providernamnet. Om du till exempel vill få hjälp för certifikatprovidern skriver du Get-Help Certificate.

Du kan också skriva help eller man, som visar en textskärm i taget. Eller , <cmdlet-name> -?som är identiskt med Get-Help, men fungerar bara för cmdletar.

Get-Help hämtar hjälpinnehållet som visas från hjälpfilerna på datorn. Utan hjälpfilerna Get-Help visar endast grundläggande information om cmdletar. Vissa PowerShell-moduler innehåller hjälpfiler. Från och med PowerShell 3.0 innehåller modulerna som medföljer Windows-operativsystemet inte hjälpfiler. Om du vill ladda ned eller uppdatera hjälpfilerna för en modul i PowerShell 3.0 använder du cmdleten Update-Help .

Du kan också visa PowerShell-hjälpdokumenten online i Microsoft Docs. Om du vill hämta onlineversionen av en hjälpfil använder du parametern Online, till exempel: Get-Help Get-Process -Online. Om du vill läsa all PowerShell-dokumentation kan du läsa Microsoft Docs PowerShell-dokumentationen.

Om du skriver Get-Help följt av det exakta namnet på en hjälpartikel, eller ett ord som är unikt för en hjälpartikel, Get-Help visas artikelns innehåll. Om du anger det exakta namnet på ett kommandoalias Get-Help visas hjälpen för det ursprungliga kommandot. Om du anger ett ord- eller ordmönster som visas i flera hjälpartikelrubriker Get-Help visas en lista över matchande rubriker. Om du anger text som inte visas i någon hjälpartikel Get-Help visas en lista med artiklar som innehåller texten i innehållet.

Get-Help kan få hjälpartiklar för alla språk och nationella inställningar som stöds. Get-Help söker först efter hjälpfiler i nationella inställningar för Windows, sedan i det överordnade språket, till exempel pt för pt-BR, och sedan i ett återställningsspråk. Från och med PowerShell 3.0 letar Get-Help den efter hjälpartiklar på engelska, en-US, innan det returnerar ett felmeddelande eller visar automatiskt genererad hjälp.

Information om de symboler som Get-Help visas i kommandosyntaxdiagrammet finns i about_Command_Syntax. Information om parameterattribut, till exempel Obligatoriskt och Position, finns i about_Parameters.

Anteckning

I PowerShell 3.0 och PowerShell 4.0 Get-Help kan du inte hitta Om artiklar i moduler om inte modulen importeras till den aktuella sessionen. Detta är ett känt problem. Om du vill hämta Om artiklar i en modul importerar du modulen, antingen med hjälp av cmdleten Import-Module eller genom att köra en cmdlet som ingår i modulen.

Exempel

Exempel 1: Visa grundläggande hjälpinformation om en cmdlet

De här exemplen visar grundläggande hjälpinformation om cmdleten Format-Table .

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> är den enklaste och standardsyntaxen för Get-Help cmdleten. Du kan utelämna parametern Namn .

Syntaxen <cmdlet-name> -? fungerar bara för cmdletar.

Exempel 2: Visa grundläggande information en sida i taget

De här exemplen visar grundläggande hjälpinformation om cmdleten Format-Table en sida i taget.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help är en funktion som kör Get-Help cmdleten internt och visar resultatet en sida i taget.

man är ett alias för funktionen help .

Get-Help Format-Table skickar objektet nedåt i pipelinen. Out-Host -Paging tar emot utdata från pipelinen och visar den en sida i taget. Mer information finns i Out-Host (Out-Host).

Exempel 3: Visa mer information för en cmdlet

De här exemplen visar mer detaljerad hjälpinformation om cmdleten Format-Table .

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Parametern Detaljerad visar hjälpartikelns detaljerade vy som innehåller parameterbeskrivningar och exempel.

Den fullständiga parametern visar hjälpartikelns fullständiga vy som innehåller parameterbeskrivningar, exempel, indata- och utdataobjekttyper och ytterligare anteckningar.

Parametrarna Detaljerad och Fullständig gäller endast för kommandon som har hjälpfiler installerade på datorn. Parametrarna är inte effektiva för hjälpartiklarna för konceptuella (about_).

Exempel 4: Visa valda delar av en cmdlet med hjälp av parametrar

De här exemplen visar valda delar av cmdlet-hjälpen Format-Table .

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Parametern Exempel visar hjälpfilens avsnitt NAME och SYNOPSIS och alla exempel. Du kan inte ange ett exempelnummer eftersom parametern Examples är en växelparameter.

Parameterparametern visar endast beskrivningarna av de angivna parametrarna. Om du bara anger jokertecknet asterisk (*) visas beskrivningarna för alla parametrar. När Parameter anger ett parameternamn, till exempel GroupBy, visas information om den parametern.

De här parametrarna är inte effektiva för hjälpartiklarna för konceptuella (about_).

Exempel 5: Visa onlineversion av hjälp

I det här exemplet visas onlineversionen av hjälpartikeln för cmdleten Format-Table i standardwebbläsaren.

Get-Help Format-Table -Online

Exempel 6: Visa hjälp om hjälpsystemet

Cmdleten Get-Help utan parametrar visar information om PowerShell-hjälpsystemet.

Get-Help

Exempel 7: Visa tillgängliga hjälpartiklar

I det här exemplet visas en lista över alla hjälpartiklar som är tillgängliga på datorn.

Get-Help *

Exempel 8: Visa en lista över konceptuella artiklar

I det här exemplet visas en lista över de konceptuella artiklar som ingår i PowerShell-hjälpen. Alla dessa artiklar börjar med tecknen about_. Om du vill visa en viss hjälpfil skriver du Get-Help \<about_article-name\>, till exempel Get-Help about_Signing.

Endast de konceptuella artiklar som har hjälpfiler installerade på datorn visas. Information om hur du laddar ned och installerar hjälpfiler i PowerShell 3.0 finns i Uppdateringshjälp.

Get-Help about_*

Exempel 9: Sök efter ett ord i cmdlet-hjälpen

Det här exemplet visar hur du söker efter ett ord i en cmdlet-hjälpartikel.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help använder parametern Fullständig för att få hjälpinformation för Add-Member. MamlCommandHelpInfo-objektet skickas ned i pipelinen. Out-Stringanvänder parametern Stream för att konvertera objektet till en sträng. Select-String använder parametern Pattern för att söka efter Clixml i strängen.

Exempel 10: Visa en lista med artiklar som innehåller ett ord

I det här exemplet visas en lista med artiklar som innehåller ordet fjärrkommunikation.

När du anger ett ord som inte visas i någon artikelrubrik Get-Help visas en lista med artiklar som innehåller det ordet.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Exempel 11: Visa providerspecifik hjälp

Det här exemplet visar två sätt att få den providerspecifika hjälpen för Get-Item. De här kommandona får hjälp som förklarar hur du använder cmdleten Get-Item i PowerShell-SQL Server providerns DataCollection-nod.

I det första exemplet används parametern Get-HelpPath för att ange SQL Server providerns sökväg. Eftersom providerns sökväg har angetts kan du köra kommandot från valfri sökväg.

I det andra exemplet används Set-Location för att navigera till SQL Server providerns sökväg. Från den platsen behövs inte parametern Path för Get-Help att få den providerspecifika hjälpen.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Exempel 12: Visa hjälp för ett skript

Det här exemplet får hjälp för MyScript.ps1 script. Information om hur du skriver hjälp för dina funktioner och skript finns i about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parametrar

-Category

Visar endast hjälp för objekt i den angivna kategorin och deras alias. Konceptuella artiklar finns i kategorin HelpFile .

Godkända värden för den här parametern är följande:

Alias
Cmdlet
Leverantör
Allmänt
Vanliga frågor
Ordlista
Hjälpfil
ScriptCommand
Funktion
Filtrera
ExternalScript
Alla
DefaultHelp
Arbetsflöde
DscResource
Klass
Konfiguration

Type:	String[]
Accepted values:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Component

Visar kommandon med det angivna komponentvärdet, till exempel Exchange. Ange ett komponentnamn. Jokertecken tillåts. Den här parametern påverkar inte visning av konceptuell hjälp (About_).

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Detailed

Lägger till parameterbeskrivningar och exempel i den grundläggande hjälpvisningen. Den här parametern gäller endast när hjälpfilerna är installerade på datorn. Det påverkar inte visning av konceptuell hjälp (About_).

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Examples

Visar bara namn, synopsis och exempel. Om du bara vill visa exemplen skriver du (Get-Help \<cmdlet-name\>).Examples.

Den här parametern gäller endast när hjälpfilerna är installerade på datorn. Det påverkar inte visning av konceptuell hjälp (About_).

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Full

Visar hela hjälpartikeln för en cmdlet. Fullständig innehåller parameterbeskrivningar och attribut, exempel, indata- och utdataobjekttyper och ytterligare anteckningar.

Den här parametern gäller endast när hjälpfilerna är installerade på datorn. Det påverkar inte visning av konceptuell hjälp (About_).

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Functionality

Visar hjälp för objekt med den angivna funktionen. Ange funktionen. Jokertecken tillåts. Den här parametern påverkar inte visning av konceptuell hjälp (About_).

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Name

Får hjälp om det angivna kommandot eller konceptet. Ange namnet på en cmdlet, funktion, provider, skript eller arbetsflöde, till exempel Get-Member, ett konceptuellt artikelnamn, till about_Objectsexempel , eller ett alias, till exempel ls. Jokertecken tillåts i cmdlet- och providernamn, men du kan inte använda jokertecken för att hitta namnen på artiklarna om funktionshjälp och skripthjälp.

Om du vill ha hjälp med ett skript som inte finns i en sökväg som anges i $env:Path miljövariabeln skriver du skriptets sökväg och filnamn.

Om du anger det exakta namnet på en hjälpartikel Get-Help visas artikelinnehållet.

Om du anger ett ord- eller ordmönster som visas i flera hjälpartikelrubriker Get-Help visas en lista över matchande rubriker.

Om du anger text som inte matchar någon hjälpartikelrubrik Get-Help visas en lista med artiklar som innehåller texten i innehållet.

Namnen på konceptuella artiklar, till exempel about_Objects, måste anges på engelska, även i icke-engelska versioner av PowerShell.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Online

Visar onlineversionen av en hjälpartikel i standardwebbläsaren. Den här parametern är endast giltig för hjälpartiklar om cmdletar, funktioner, arbetsflöden och skript. Du kan inte använda onlineparametern med Get-Help i en fjärrsession.

Information om hur du stöder den här funktionen i hjälpartiklar som du skriver finns i about_Comment_Based_Help och Support onlinehjälp och Skriva hjälp för PowerShell-cmdletar.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Parameter

Visar endast detaljerade beskrivningar av de angivna parametrarna. Jokertecken tillåts. Den här parametern påverkar inte visning av konceptuell hjälp (About_).

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Path

Får hjälp som förklarar hur cmdleten fungerar i den angivna providersökvägen. Ange en PowerShell-providersökväg.

Den här parametern hämtar en anpassad version av en cmdlet-hjälpartikel som förklarar hur cmdleten fungerar i den angivna PowerShell-providersökvägen. Den här parametern gäller endast för hjälp om en provider-cmdlet och endast när providern innehåller en anpassad version av cmdlet-hjälpartikeln för providern i hjälpfilen. Om du vill använda den här parametern installerar du hjälpfilen för modulen som innehåller providern.

Om du vill se den anpassade cmdlet-hjälpen för en providersökväg går du till platsen för providersökvägen och anger ett Get-Help kommando eller använder parametern Get-HelpPath för för att ange providersökvägen från valfri sökvägsplats. Du hittar också anpassad cmdlet-hjälp online i avsnittet om providerhjälp i hjälpartiklarna.

Mer information om PowerShell-leverantörer finns i about_Providers.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Role

Visar hjälp som är anpassad för den angivna användarrollen. Ange en roll. Jokertecken tillåts.

Ange den roll som användaren spelar i en organisation. Vissa cmdletar visar olika text i sina hjälpfiler baserat på värdet för den här parametern. Den här parametern har ingen effekt på hjälpen för kärn-cmdletar.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ShowWindow

Visar hjälpavsnittet i ett fönster för enklare läsning. Fönstret innehåller en Sök-funktion och en inställningsruta där du kan ange alternativ för visningen, inklusive alternativ för att endast visa valda avsnitt i ett hjälpavsnitt.

Parametern ShowWindow stöder hjälpavsnitt för kommandon (cmdletar, funktioner, CIM-kommandon, skript) och begreppsmässiga Om artiklar. Det stöder inte providerhjälp.

Den här parametern återinfördes i PowerShell 7.0.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Indata

None

Du kan inte skicka objekt i pipelinen till Get-Help.

Utdata

ExtendedCmdletHelpInfo

Om du kör Get-Help ett kommando som inte har någon hjälpfil Get-Help returneras ett ExtendedCmdletHelpInfo-objekt som representerar automatiskt genererad hjälp.

String

Om du får en konceptuell hjälpartikel Get-Help returneras den som en sträng.

MamlCommandHelpInfo

Om du får ett kommando som har en hjälpfil Get-Help returneras ett MamlCommandHelpInfo-objekt .

Kommentarer

PowerShell 3.0 innehåller inte hjälpfiler. Om du vill ladda ned och installera hjälpfilerna som Get-Help läser använder du cmdleten Update-Help . Du kan använda cmdleten Update-Help för att ladda ned och installera hjälpfiler för de kärnkommandon som medföljer PowerShell och för alla moduler som du installerar. Du kan också använda den för att uppdatera hjälpfilerna så att hjälpen på datorn aldrig är inaktuell.

Du kan också läsa hjälpartiklarna om de kommandon som medföljer PowerShell online från och med Komma igång med Windows PowerShell.

Get-Help visar hjälp i nationella inställningar för Windows-operativsystemet eller på återställningsspråket för det språket. Om du inte har hjälpfiler för det primära språket eller återställningsspråket Get-Help fungerar det som om det inte finns några hjälpfiler på datorn. Om du vill ha hjälp med ett annat språk använder du Region och Språk i Kontrollpanelen för att ändra inställningarna. På Windows 10 eller senare, Inställningar, Tid & Språk.

Den fullständiga vyn av hjälpen innehåller en tabell med information om parametrarna. Tabellen innehåller följande fält:

Krävs. Anger om parametern krävs (sant) eller valfritt (falskt).
Position. Anger om parametern heter eller är positionell (numerisk). Positionsparametrar måste visas på en angiven plats i kommandot.
Namngivet anger att parameternamnet krävs, men att parametern kan visas var som helst i kommandot.
Numeriskt anger att parameternamnet är valfritt, men när namnet utelämnas måste parametern finnas på den plats som anges av talet. Anger till exempel 2 att när parameternamnet utelämnas måste parametern vara den andra eller enda namnlösa parametern i kommandot. När parameternamnet används kan parametern visas var som helst i kommandot .
Standardvärde. Parametervärdet eller standardbeteendet som PowerShell använder om du inte inkluderar parametern i kommandot .
Accepterar pipelineindata. Anger om du kan (sant) eller inte kan (falskt) skicka objekt till parametern via en pipeline. Med Egenskapsnamn innebär det att pipeline-objektet måste ha en egenskap som har samma namn som parameternamnet.
Accepterar jokertecken. Anger om värdet för en parameter kan innehålla jokertecken, till exempel en asterisk (*) eller ett frågetecken (?).