Share via

Start-Job

  • Referenz
Modul:
Microsoft.PowerShell.Core

Startet einen PowerShell-Hintergrundauftrag.

Syntax

Start-Job
     [-Name <String>]
     [-ScriptBlock] <ScriptBlock>
     [-Credential <PSCredential>]
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]
Start-Job
     [-DefinitionName] <String>
     [[-DefinitionPath] <String>]
     [[-Type] <String>]
     [<CommonParameters>]
Start-Job
     [-Name <String>]
     [-Credential <PSCredential>]
     [-FilePath] <String>
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]
Start-Job
     [-Name <String>]
     [-Credential <PSCredential>]
     -LiteralPath <String>
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

Beschreibung

Das Start-Job Cmdlet startet einen PowerShell-Hintergrundauftrag auf dem lokalen Computer.

Ein PowerShell-Hintergrundauftrag führt einen Befehl aus, ohne mit der aktuellen Sitzung zu interagieren. Wenn Sie einen Hintergrundauftrag starten, wird selbst dann sofort ein Auftragsobjekt zurückgegeben, wenn der Abschluss des Auftrags längere Zeit in Anspruch nimmt. Sie können ohne Unterbrechung in der Sitzung weiterarbeiten, während der Auftrag abgeschlossen wird.

Das Auftragsobjekt enthält nützliche Informationen zum Auftrag, enthält aber nicht die Auftragsergebnisse. Wenn der Auftrag abgeschlossen ist, verwenden Sie das Receive-Job Cmdlet, um die Ergebnisse des Auftrags abzurufen. Weitere Informationen zu Hintergrundaufträgen finden Sie unter about_Jobs.

Verwenden Sie zum Ausführen eines Hintergrundauftrags auf einem Remotecomputer den AsJob-Parameter, der für viele Cmdlets verfügbar ist, oder verwenden Sie das Invoke-Command Cmdlet, um einen Start-Job Befehl auf dem Remotecomputer auszuführen. Weitere Informationen finden Sie unter about_Remote_Jobs.

Ab PowerShell 3.0 Start-Job können Instanzen von benutzerdefinierten Auftragstypen, z. B. geplante Aufträge, gestartet werden. Informationen zum Start-Job Starten von Aufträgen mit benutzerdefinierten Typen finden Sie in den Hilfedokumenten für die Auftragstypfunktion.

Das Standardarbeitsverzeichnis für Aufträge ist hartcodiert. Die Windows-Standardeinstellung ist $HOME\Documents und unter Linux oder macOS ist die Standardeinstellung $HOME. Der skriptcode, der im Hintergrundauftrag ausgeführt wird, muss das Arbeitsverzeichnis nach Bedarf verwalten.

Beispiele

Beispiel 1: Starten eines Hintergrundauftrags

In diesem Beispiel wird ein Hintergrundauftrag gestartet, der auf dem lokalen Computer ausgeführt wird.

Start-Job -ScriptBlock { Get-Process -Name powershell }

Id  Name   PSJobTypeName   State     HasMoreData   Location    Command
--  ----   -------------   -----     -----------   --------    -------
1   Job1   BackgroundJob   Running   True          localhost   Get-Process -Name powershell

Start-Job verwendet den ScriptBlock-Parameter , um als Hintergrundauftrag auszuführen Get-Process . Der Parameter Name gibt an, um PowerShell-Prozesse zu finden. powershell Die Auftragsinformationen werden angezeigt, und PowerShell kehrt zu einer Eingabeaufforderung zurück, während der Auftrag im Hintergrund ausgeführt wird.

Verwenden Sie das Receive-Job Cmdlet, um die Ausgabe des Auftrags anzuzeigen. Beispiel: Receive-Job -Id 1.

Beispiel 2: Starten eines Auftrags mit Invoke-Command

In diesem Beispiel wird ein Auftrag auf mehreren Computern ausgeführt. Der Auftrag wird in einer Variablen gespeichert und mithilfe des Variablennamens in der PowerShell-Befehlszeile ausgeführt.

$jobWRM = Invoke-Command -ComputerName (Get-Content -Path C:\Servers.txt) -ScriptBlock {
   Get-Service -Name WinRM } -JobName WinRM -ThrottleLimit 16 -AsJob

Ein Auftrag, der verwendet Invoke-Command wird, wird erstellt und in der $jobWRM Variablen gespeichert. Invoke-Command verwendet den Parameter ComputerName , um die Computer anzugeben, auf denen der Auftrag ausgeführt wird. Get-Content ruft die Servernamen aus der C:\Servers.txt Datei ab.

Der Parameter ScriptBlock gibt einen Befehl an, Get-Service der den WinRM-Dienst abruft . Der Parameter JobName gibt einen Anzeigenamen für den Auftrag WinRM an. Der Parameter ThrottleLimit begrenzt die Anzahl der gleichzeitigen Befehle auf 16. Der Parameter AsJob startet einen Hintergrundauftrag, der den Befehl auf den Servern ausführt.

Beispiel 3: Abrufen von Auftragsinformationen

In diesem Beispiel werden Informationen zu einem Auftrag und die Ergebnisse eines abgeschlossenen Auftrags angezeigt, der auf dem lokalen Computer ausgeführt wurde.

$j = Start-Job -ScriptBlock { Get-WinEvent -Log System } -Credential Domain01\User01
$j | Select-Object -Property *

State         : Completed
HasMoreData   : True
StatusMessage :
Location      : localhost
Command       : Get-WinEvent -Log System
JobStateInfo  : Completed
Finished      : System.Threading.ManualResetEvent
InstanceId    : 27ce3fd9-40ed-488a-99e5-679cd91b9dd3
Id            : 18
Name          : Job18
ChildJobs     : {Job19}
PSBeginTime   : 8/8/2019 14:41:57
PSEndTime     : 8/8/2019 14:42:07
PSJobTypeName : BackgroundJob
Output        : {}
Error         : {}
Progress      : {}
Verbose       : {}
Debug         : {}
Warning       : {}
Information   : {}

Start-Job verwendet den ScriptBlock-Parameter , um einen Befehl auszuführen, der angibt Get-WinEvent , dass das Systemprotokoll abgerufen wird. Der Parameter "Credential" gibt ein Do Standard Benutzerkonto mit der Berechtigung zum Ausführen des Auftrags auf dem Computer an. Das Auftragsobjekt wird in der $j Variablen gespeichert.

Das Objekt in der $j Variablen wird an die Pipeline gesendet.Select-Object Der Parameter Property gibt ein Sternchen (*) an, um alle Eigenschaften des Auftragsobjekts anzuzeigen.

Beispiel 4: Ausführen eines Skripts als Hintergrundauftrag

In diesem Beispiel wird ein Skript auf dem lokalen Computer als Hintergrundauftrag ausgeführt.

Start-Job -FilePath C:\Scripts\Sample.ps1

Start-Job verwendet den FilePath-Parameter , um eine Skriptdatei anzugeben, die auf dem lokalen Computer gespeichert ist.

Beispiel 5: Abrufen eines Prozesses mithilfe eines Hintergrundauftrags

In diesem Beispiel wird ein Hintergrundauftrag verwendet, um einen angegebenen Prozess anhand des Namens abzurufen.

Start-Job -Name PShellJob -ScriptBlock { Get-Process -Name PowerShell }

Start-Job verwendet den Parameter Name , um einen Anzeigeauftragsnamen, PShellJob, anzugeben. Der ScriptBlock-Parameter gibt an Get-Process , prozesse mit dem Namen PowerShell abzurufen.

Beispiel 6: Sammeln und Speichern von Daten mithilfe eines Hintergrundauftrags

In diesem Beispiel wird ein Auftrag gestartet, der eine große Menge von Kartendaten sammelt und dann in einer .tif Datei speichert.

Start-Job -Name GetMappingFiles -InitializationScript {Import-Module -Name MapFunctions} -ScriptBlock {
   Get-Map -Name * | Set-Content -Path D:\Maps.tif } -RunAs32

Start-Job verwendet den Parameter Name , um einen Anzeigeauftragsnamen, GetMappingFiles, anzugeben. Der Parameter InitializationScript führt einen Skriptblock aus, der das MapFunctions-Modul importiert. Der ScriptBlock-Parameter wird ausgeführt Get-Map und Set-Content speichert die Daten an dem durch den Path-Parameter angegebenen Speicherort. Der RunAs32-Parameter führt den Prozess auch auf einem 64-Bit-Betriebssystem als 32-Bit-Version aus.

Beispiel 7: Übergeben von Eingaben an einen Hintergrundauftrag

In diesem Beispiel wird die $input automatische Variable verwendet, um ein Eingabeobjekt zu verarbeiten. Wird Receive-Job verwendet, um die Ausgabe des Auftrags anzuzeigen.

Start-Job -ScriptBlock { Get-Content -Path $input } -InputObject "C:\Servers.txt"
Receive-Job -Name Job45 -Keep

Server01
Server02
Server03
Server04

Start-Jobverwendet den ScriptBlock-Parameter, um mit der $input automatischen Variablen auszuführenGet-Content. Die $input Variable ruft Objekte aus dem InputObject-Parameter ab. Receive-Job verwendet den Parameter Name , um den Auftrag anzugeben und die Ergebnisse auszugeben. Der Parameter Keep speichert die Auftragsausgabe, damit sie während der PowerShell-Sitzung erneut angezeigt werden kann.

Beispiel 8: Verwenden des ArgumentList-Parameters zum Angeben eines Arrays

In diesem Beispiel wird der ArgumentList-Parameter verwendet, um ein Array von Argumenten anzugeben. Das Array ist eine durch Trennzeichen getrennte Liste von Prozessnamen.

Start-Job -ScriptBlock { Get-Process -Name $args } -ArgumentList powershell, pwsh, notepad

Id     Name      PSJobTypeName   State       HasMoreData     Location     Command
--     ----      -------------   -----       -----------     --------     -------
1      Job1      BackgroundJob   Running     True            localhost    Get-Process -Name $args

Das Start-Job Cmdlet verwendet den ScriptBlock-Parameter , um einen Befehl auszuführen. Get-Process verwendet den Parameter Name , um die automatische Variable $argsanzugeben. Der ArgumentList-Parameter übergibt das Array von Prozessnamen an $args. Die Prozessnamen powershell, pwsh und Notepad werden auf dem lokalen Computer ausgeführt.

Verwenden Sie das Receive-Job Cmdlet, um die Ausgabe des Auftrags anzuzeigen. Beispiel: Receive-Job -Id 1.

Parameter

-ArgumentList

Gibt ein Array von Argumenten oder Parameterwerten für das Skript an, das durch den FilePath-Parameter oder einen befehl angegeben wird, der mit dem ScriptBlock-Parameter angegeben ist.

Argumente müssen als Eindimension-Arrayargument an ArgumentList übergeben werden. Beispiel: eine durch Trennzeichen getrennte Liste. Weitere Informationen zum Verhalten von ArgumentList finden Sie unter about_Splatting.

Type:Object[]
Aliases:Args
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Authentication

Gibt den Mechanismus an, der zum Authentifizieren von Benutzeranmeldeinformationen verwendet wird.

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • Standard
  • Grundlegend
  • Credssp
  • Digest
  • Kerberos
  • Aushandeln
  • NegotiateWithImplicitCredential

Der Standardwert lautet Default.

CredSSP-Authentifizierung ist nur in Windows Vista, Windows Server 2008 und höheren Versionen des Windows-Betriebssystems verfügbar.

Weitere Informationen zu den Werten dieses Parameters finden Sie unter AuthenticationMechanism.

Achtung

Credential Security Support Provider (CredSSP)-Authentifizierung, bei der die Anmeldeinformationen des Benutzers an einen Remotecomputer übergeben werden, der authentifiziert werden soll, ist für Befehle konzipiert, die eine Authentifizierung für mehrere Ressourcen erfordern, z. B. den Zugriff auf eine Remotenetzwerkfreigabe. Dieser Mechanismus erhöht das Sicherheitsrisiko des Remotevorgangs. Wenn die Sicherheit des Remotecomputers gefährdet ist, können die an ihn übergebenen Anmeldeinformationen zum Steuern der Netzwerksitzung verwendet werden.

Type:AuthenticationMechanism
Accepted values:Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
Position:Named
Default value:Default
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Gibt ein Benutzerkonto an, das über die Berechtigung zum Ausführen dieser Aktion verfügt. Wenn der Parameter "Credential " nicht angegeben ist, verwendet der Befehl die Anmeldeinformationen des aktuellen Benutzers.

Geben Sie einen Benutzernamen ein, z. B. "User01" oder "Do Standard 01\User01", oder geben Sie ein vom Cmdlet generiertes Get-Credential PSCredential-Objekt ein. Wenn Sie einen Benutzernamen eingeben, werden Sie aufgefordert, das Kennwort einzugeben.

Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString gespeichert.

Hinweis

Weitere Informationen zum Schutz von SecureString finden Sie unter "Wie sicher ist SecureString?".

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefinitionName

Gibt den Definitionsnamen des Auftrags an, den dieses Cmdlet startet. Verwenden Sie diesen Parameter, um benutzerdefinierte Auftragstypen zu starten, die über einen Definitionsnamen verfügen, z. B. geplante Aufträge.

Wenn Sie Start-Job eine Instanz eines geplanten Auftrags starten, wird der Auftrag sofort gestartet, unabhängig von Auftragsauslösern oder Auftragsoptionen. Die resultierende Auftragsinstanz ist ein geplanter Auftrag, wird jedoch nicht auf dem Datenträger gespeichert, z. B. ausgelöste geplante Aufträge. Sie können den ArgumentList-ParameterStart-Job nicht verwenden, um Werte für Parameter von Skripts bereitzustellen, die in einem geplanten Auftrag ausgeführt werden. Weitere Informationen finden Sie unter about_Scheduled_Jobs.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

-DefinitionPath

Gibt den Pfad der Definition für den Auftrag an, den dieses Cmdlet startet. Geben Sie den Definitionspfad ein. Die Verkettung der Werte der Parameter DefinitionPath und DefinitionName ist der vollqualifizierte Pfad der Auftragsdefinition. Verwenden Sie diesen Parameter, um benutzerdefinierte Auftragstypen zu starten, die über einen Definitionspfad verfügen, z. B. geplante Aufträge.

Bei geplanten Aufträgen lautet $HOME\AppData\Local\Windows\PowerShell\ScheduledJobder Wert des DefinitionPath-Parameters .

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

-FilePath

Gibt ein lokales Skript an, das Start-Job als Hintergrundauftrag ausgeführt wird. Geben Sie den Pfad und Dateinamen des Skripts ein, oder verwenden Sie die Pipeline, um einen Skriptpfad zu senden.Start-Job Das Skript muss sich auf dem lokalen Computer oder in einem Ordner befinden, auf den der lokale Computer zugreifen kann.

Wenn Sie diesen Parameter verwenden, konvertiert PowerShell den Inhalt der angegebenen Skriptdatei in einen Skriptblock und führt den Skriptblock als Hintergrundauftrag aus.

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

-InitializationScript

Gibt Befehle an, die vor dem Starten des Auftrags ausgeführt werden. Um einen Skriptblock zu erstellen, schließen Sie die Befehle in geschweifte geschweifte Klammern ({}) ein.

Verwenden Sie diesen Parameter zum Vorbereiten der Sitzung, in der der Auftrag ausgeführt wird. Sie können damit beispielsweise Funktionen, Snap-Ins und Module zur Sitzung hinzufügen.

Type:ScriptBlock
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Gibt die Eingabe für den Befehl an. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder einen Ausdruck ein, der die Objekte generiert.

Verwenden Sie im Wert des ScriptBlock-Parameters die $input automatische Variable, um die Eingabeobjekte darzustellen.

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

-LiteralPath

Gibt ein lokales Skript an, das dieses Cmdlet als Hintergrundauftrag ausführt. Geben Sie den Pfad eines Skripts auf dem lokalen Computer ein.

Start-Job verwendet den Wert des LiteralPath-Parameters genau so, wie er eingegeben wird. Es werden keine Zeichen als Platzhalter interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.

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

-Name

Gibt einen Anzeigenamen für den neuen Auftrag an. Sie können den Namen verwenden, um den Auftrag für andere Auftrags-Cmdlets zu identifizieren, z. B. das Stop-Job Cmdlet.

Der Standardmäßige Anzeigename ist Job#, wobei # es sich um eine Ordnungszahl handelt, die für jeden Auftrag erhöht wird.

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

-PSVersion

Gibt eine Version an. Start-Job führt den Auftrag mit der Version von PowerShell aus. Die zulässigen Werte für diesen Parameter sind: 2.0 und 3.0.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

-RunAs32

Gibt an, dass Start-Job der Auftrag in einem 32-Bit-Prozess ausgeführt wird. RunAs32 erzwingt die Ausführung des Auftrags in einem 32-Bit-Prozess, auch auf einem 64-Bit-Betriebssystem.

Bei 64-Bit-Versionen von Windows 7 und Windows Server 2008 R2 können Sie, wenn der Start-Job Befehl den RunAs32-Parameter enthält, nicht den Parameter "Credential " verwenden, um die Anmeldeinformationen eines anderen Benutzers anzugeben.

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

-ScriptBlock

Gibt die im Hintergrundauftrag auszuführenden Befehle an. Um einen Skriptblock zu erstellen, schließen Sie die Befehle in geschweifte geschweifte Klammern ({}) ein. Verwenden Sie die $input automatische Variable, um auf den Wert des InputObject-Parameters zuzugreifen. Dieser Parameter ist erforderlich.

Type:ScriptBlock
Aliases:Command
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Type

Gibt den benutzerdefinierten Typ für Aufträge an, die von Start-Job. Geben Sie einen benutzerdefinierten Auftragstypnamen ein, wie z. B. „PSScheduledJob“ für geplante Aufträge oder „SWorkflowJob“für Workflowaufträge. Dieser Parameter ist nicht gültig für Standardhintergrundaufträge.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

Eingaben

String

Sie können ein Objekt mit der Name-Eigenschaft an den Parameter Name an dieses Cmdlet weiterleiten. Sie können z. B. ein FileInfo-Objekt von Get-ChildItem.

Ausgaben

System.Management.Automation.PSRemotingJob

Dieses Cmdlet gibt ein PSRemotingJob -Objekt zurück, das den Auftrag darstellt, den er gestartet hat.

Hinweise

Windows PowerShell enthält die folgenden Aliase für Start-Job:

  • sajb

Um im Hintergrund auszuführen, Start-Job wird in einer eigenen Sitzung in der aktuellen Sitzung ausgeführt. Wenn Sie das Invoke-Command Cmdlet verwenden, um einen Start-Job Befehl in einer Sitzung auf einem Remotecomputer auszuführen, Start-Job wird sie in einer Sitzung in der Remotesitzung ausgeführt.