Start-Job

Módulo:

Microsoft.PowerShell.Core

Inicia un trabajo en segundo plano de PowerShell.

Syntax

Start-Job
     [-Name <String>]
     [-ScriptBlock] <ScriptBlock>
     [-Credential <PSCredential>]
     [-Authentication <AuthenticationMechanism>]
     [[-InitializationScript] <ScriptBlock>]
     [-WorkingDirectory <String>]
     [-RunAs32]
     [-PSVersion <Version>]
     [-InputObject <PSObject>]
     [-ArgumentList <Object[]>]
     [<CommonParameters>]

Start-Job
     [-DefinitionName] <String>
     [[-DefinitionPath] <String>]
     [[-Type] <String>]
     [-WorkingDirectory <String>]
     [<CommonParameters>]

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

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

Description

El Start-Job cmdlet inicia un trabajo en segundo plano de PowerShell en el equipo local.

Un trabajo en segundo plano de PowerShell ejecuta un comando sin interactuar con la sesión actual. Cuando se inicia un trabajo en segundo plano, se devuelve inmediatamente un objeto de trabajo, incluso aunque el trabajo tarde mucho en finalizar. Puede seguir trabajando en la sesión sin interrupción mientras se ejecuta el trabajo.

El objeto de trabajo contiene información útil sobre el trabajo, pero no contiene los resultados del trabajo. Cuando finalice el trabajo, use el Receive-Job cmdlet para obtener los resultados del trabajo. Para obtener más información sobre los trabajos en segundo plano, vea about_Jobs.

Para ejecutar un trabajo en segundo plano en un equipo remoto, use el parámetro AsJob que está disponible en muchos cmdlets o use el Invoke-Command cmdlet para ejecutar un Start-Job comando en el equipo remoto. Para obtener más información, consulte about_Remote_Jobs.

A partir de PowerShell 3.0, Start-Job puede iniciar instancias de tipos de trabajo personalizados, como trabajos programados. Para obtener información sobre cómo usar Start-Job para iniciar trabajos con tipos personalizados, consulte los documentos de ayuda de la característica de tipo de trabajo.

A partir de PowerShell 6.0, puede iniciar trabajos mediante el operador en segundo plano de y comercial (&). La funcionalidad del operador en segundo plano es similar a Start-Job. Ambos métodos para iniciar un trabajo crean un objeto de trabajo PSRemotingJob . Para obtener más información sobre el uso de la y comercial (&), consulte about_Operators.

PowerShell 7 introdujo el parámetro WorkingDirectory que especifica el directorio de trabajo inicial de un trabajo en segundo plano. Si no se especifica el parámetro , Start-Job el valor predeterminado es el directorio de trabajo actual del autor de la llamada que inició el trabajo.

Nota:

No se admite la creación de un trabajo en segundo plano fuera de proceso con Start-Job en el escenario en el que PowerShell se hospeda en otras aplicaciones, como Azure Functions de PowerShell.

Esto es por diseño porque Start-Job depende del archivo ejecutable en el pwsh que esté disponible $PSHOME para iniciar un trabajo en segundo plano fuera del proceso, pero cuando una aplicación hospeda PowerShell, se usa directamente los paquetes del SDK de NuGet de PowerShell y no se han pwsh enviado a lo largo.

El sustituto en ese escenario procede Start-ThreadJob del módulo ThreadJob.

Ejemplos

Ejemplo 1: Iniciar un trabajo en segundo plano

En este ejemplo se inicia un trabajo en segundo plano que se ejecuta en el equipo local.

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

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

Start-Job usa el parámetro ScriptBlock para ejecutarse Get-Process como un trabajo en segundo plano. El parámetro Name especifica para buscar procesos de PowerShell, pwsh. Se muestra la información del trabajo y PowerShell vuelve a un mensaje mientras el trabajo se ejecuta en segundo plano.

Para ver la salida del trabajo, use el Receive-Job cmdlet . Por ejemplo, Receive-Job -Id 1.

Ejemplo 2: Uso del operador en segundo plano para iniciar un trabajo en segundo plano

En este ejemplo se usa el operador en segundo plano y comercial (&) para iniciar un trabajo en segundo plano en el equipo local. El trabajo obtiene el mismo resultado que Start-Job en el ejemplo 1.

Get-Process -Name pwsh &

Id    Name   PSJobTypeName   State       HasMoreData     Location      Command
--    ----   -------------   -----       -----------     --------      -------
5     Job5   BackgroundJob   Running     True            localhost     Microsoft.PowerShell.Man...

Get-Process usa el parámetro Name para especificar procesos de PowerShell, pwsh. La y comercial (&) ejecuta el comando como un trabajo en segundo plano. Se muestra la información del trabajo y PowerShell vuelve a un mensaje mientras el trabajo se ejecuta en segundo plano.

Para ver la salida del trabajo, use el Receive-Job cmdlet . Por ejemplo, Receive-Job -Id 5.

Ejemplo 3: Iniciar un trabajo mediante Invoke-Command

En este ejemplo se ejecuta un trabajo en varios equipos. El trabajo se almacena en una variable y se ejecuta mediante el nombre de la variable en la línea de comandos de PowerShell.

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

Un trabajo que usa Invoke-Command se crea y almacena en la $jobWRM variable . Invoke-Command usa el parámetro ComputerName para especificar los equipos donde se ejecuta el trabajo. Get-Content obtiene los nombres de servidor del C:\Servers.txt archivo.

El parámetro ScriptBlock especifica un comando que Get-Service obtiene el servicio WinRM . El parámetro JobName especifica un nombre descriptivo para el trabajo, WinRM. El parámetro ThrottleLimit limita el número de comandos simultáneos a 16. El parámetro AsJob inicia un trabajo en segundo plano que ejecuta el comando en los servidores.

Ejemplo 4: Obtener información del trabajo

En este ejemplo se obtiene información sobre un trabajo y se muestran los resultados de un trabajo completado que se ejecutó en el equipo local.

$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 usa el parámetro ScriptBlock para ejecutar un comando que especifica Get-WinEvent para obtener el registro del sistema . El parámetro Credential especifica una cuenta de usuario de dominio con permiso para ejecutar el trabajo en el equipo. El objeto de trabajo se almacena en la $j variable .

El objeto de la $j variable se envía a la canalización a Select-Object. El parámetro Property especifica un asterisco (*) para mostrar todas las propiedades del objeto de trabajo.

Ejemplo 5: Ejecución de un script como trabajo en segundo plano

En este ejemplo, se ejecuta un script en el equipo local como un trabajo en segundo plano.

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

Start-Job usa el parámetro FilePath para especificar un archivo de script almacenado en el equipo local.

Ejemplo 6: Obtención de un proceso mediante un trabajo en segundo plano

En este ejemplo se usa un trabajo en segundo plano para obtener un proceso especificado por nombre.

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

Start-Job usa el parámetro Name para especificar un nombre de trabajo descriptivo, PShellJob. El parámetro ScriptBlock especifica Get-Process para obtener procesos con el nombre PowerShell.

Ejemplo 7: Recopilar y guardar datos mediante un trabajo en segundo plano

En este ejemplo se inicia un trabajo que recopila una gran cantidad de datos de mapa y, a continuación, se guarda en un .tif archivo.

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

Start-Job usa el parámetro Name para especificar un nombre de trabajo descriptivo, GetMappingFiles. El parámetro InitializationScript ejecuta un bloque de script que importa el módulo MapFunctions . El parámetro ScriptBlock se ejecuta Get-Map y Set-Content guarda los datos en la ubicación especificada por el parámetro Path .

Ejemplo 8: Pasar la entrada a un trabajo en segundo plano

En este ejemplo se usa la $input variable automática para procesar un objeto de entrada. Use Receive-Job para ver la salida del trabajo.

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

Server01
Server02
Server03
Server04

Start-Job usa el parámetro ScriptBlock para ejecutarse Get-Content con la $input variable automática. La $input variable obtiene objetos del parámetro InputObject . Receive-Job usa el parámetro Name para especificar el trabajo y genera los resultados. El parámetro Keep guarda la salida del trabajo para que se pueda volver a ver durante la sesión de PowerShell.

Ejemplo 9: Establecimiento del directorio de trabajo para un trabajo en segundo plano

WorkingDirectory permite especificar un directorio alternativo para un trabajo desde el que puede ejecutar scripts o abrir archivos. En este ejemplo, el trabajo en segundo plano especifica un directorio de trabajo diferente de la ubicación del directorio actual.

PS C:\Test> Start-Job -WorkingDirectory C:\Test\Scripts { $PWD } | Receive-Job -AutoRemoveJob -Wait

Path
----
C:\Test\Scripts

El directorio de trabajo actual de este ejemplo es C:\Test. Start-Job usa el parámetro WorkingDirectory para especificar el directorio de trabajo del trabajo. El parámetro ScriptBlock usa $PWD para mostrar el directorio de trabajo del trabajo. Receive-Job muestra la salida del trabajo en segundo plano. AutoRemoveJob elimina el trabajo y Wait suprime el símbolo del sistema hasta que se reciban todos los resultados.

Ejemplo 10: Usar el parámetro ArgumentList para especificar una matriz

En este ejemplo se usa el parámetro ArgumentList para especificar una matriz de argumentos. La matriz es una lista separada por comas de nombres de proceso.

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

El Start-Job cmdlet usa el parámetro ScriptBlock para ejecutar un comando. Get-Process usa el parámetro Name para especificar la variable $argsautomática . El parámetro ArgumentList pasa la matriz de nombres de proceso a $args. Los nombres de proceso powershell, pwsh y el Bloc de notas son procesos que se ejecutan en el equipo local.

Para ver la salida del trabajo, use el Receive-Job cmdlet . Por ejemplo, Receive-Job -Id 1.

Ejemplo 11: Ejecución de un trabajo en Windows PowerShell 5.1

En este ejemplo se usa el parámetro PSVersion con el valor 5.1 para ejecutar el trabajo en una sesión de Windows PowerShell 5.1.

$PSVersionTable.PSVersion

Major  Minor  Patch  PreReleaseLabel BuildLabel
-----  -----  -----  --------------- ----------
7      0      0      rc.1

$job = Start-Job -ScriptBlock { $PSVersionTable.PSVersion } -PSVersion 5.1
Receive-Job -Job $job

Major  Minor  Build  Revision
-----  -----  -----  --------
5      1      14393  3383

Parámetros

-ArgumentList

Especifica una matriz de argumentos o valores de parámetro para el script especificado por el parámetro FilePath o un comando especificado con el parámetro ScriptBlock .

Los argumentos se deben pasar a ArgumentList como argumento de matriz de una sola dimensión. Por ejemplo, una lista separada por comas. Para obtener más información sobre el comportamiento de ArgumentList, vea about_Splatting.

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

-Authentication

Especifica el mecanismo que se usa para autenticar las credenciales de usuario.

Los valores aceptables para este parámetro son los siguientes:

• Valor predeterminado
• Basic
• Credssp
• Digest
• Kerberos
• Negotiate
• NegotiateWithImplicitCredential

El valor predeterminado es Default.

La autenticación CredSSP solo está disponible en Windows Vista, Windows Server 2008 y versiones posteriores del sistema operativo Windows.

Para obtener más información sobre los valores de este parámetro, vea AuthenticationMechanism.

Precaución

La autenticación del proveedor de soporte técnico de seguridad de credenciales (CredSSP), en la que las credenciales del usuario se pasan a un equipo remoto para autenticarse, está diseñada para comandos que requieren autenticación en más de un recurso, como el acceso a un recurso compartido de red remoto. Este mecanismo el riesgo de seguridad de la operación remota. Si el equipo remoto se ve comprometido, las credenciales que se pasen a él se pueden utilizar para controlar la sesión de red.

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

Especifica una cuenta de usuario con permiso para realizar esta acción. Si no se especifica el parámetro Credential , el comando usa las credenciales del usuario actual.

Escriba un nombre de usuario, como User01 o Domain01\User01, o escriba un objeto PSCredential generado por el Get-Credential cmdlet . Si escribe un nombre de usuario, se le pedirá que escriba la contraseña.

Las credenciales se almacenan en un objeto PSCredential y la contraseña se almacena como SecureString.

Nota:

Para obtener más información sobre la protección de datos SecureString , consulte ¿Cómo es secure is SecureString?.

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

-DefinitionName

Especifica el nombre de definición del trabajo que inicia este cmdlet. Use este parámetro para iniciar tipos de trabajo personalizados que tengan un nombre de definición, como los trabajos programados.

Cuando se usa Start-Job para iniciar una instancia de un trabajo programado, el trabajo se inicia inmediatamente, independientemente de los desencadenadores de trabajo o las opciones de trabajo. La instancia de trabajo resultante es un trabajo programado, pero no se guarda en el disco como los trabajos programados desencadenados. No se puede usar el parámetro ArgumentList de Start-Job para proporcionar valores para los parámetros de los scripts que se ejecutan en un trabajo programado.

Este parámetro se introdujo en PowerShell 3.0.

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

-DefinitionPath

Especifica la ruta de acceso de la definición del trabajo que se inicia este cmdlet. Escriba la ruta de acceso de definición. La concatenación de los valores de los parámetros DefinitionPath y DefinitionName es la ruta de acceso completa de la definición del trabajo. Use este parámetro para iniciar tipos de trabajo personalizados que tengan una ruta de acceso de definición, como los trabajos programados.

Para los trabajos programados, el valor del parámetro DefinitionPath es $HOME\AppData\Local\Windows\PowerShell\ScheduledJob.

Este parámetro se introdujo en PowerShell 3.0.

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

-FilePath

Especifica un script local que Start-Job se ejecuta como un trabajo en segundo plano. Escriba la ruta de acceso y el nombre de archivo del script o use la canalización para enviar una ruta de acceso de script a Start-Job. El script debe estar en el equipo local o en una carpeta a la que pueda acceder el equipo local.

Cuando se usa este parámetro, PowerShell convierte el contenido del archivo de script especificado en un bloque de script y ejecuta el bloque de script como un trabajo en segundo plano.

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

-InitializationScript

Especifica los comandos que se ejecutan antes de que se inicie el trabajo. Para crear un bloque de script, incluya los comandos entre llaves ({}).

Use este parámetro para preparar la sesión en la que se ejecuta el trabajo. Por ejemplo, puede usarlo para agregar funciones, complementos y módulos a la sesión.

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

-InputObject

Especifica entradas del comando. Escriba una variable que contenga los objetos, o escriba un comando o una expresión que genere los objetos.

En el valor del parámetro ScriptBlock , use la $input variable automática para representar los objetos de entrada.

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

-LiteralPath

Especifica un script local que este cmdlet se ejecuta como un trabajo en segundo plano. Escriba la ruta de acceso de un script en el equipo local.

Start-Job usa el valor del parámetro LiteralPath exactamente como se escribe. Ningún carácter se interpreta como carácter comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

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

-Name

Especifica un nombre descriptivo para el nuevo trabajo. Puede usar el nombre para identificar el trabajo con otros cmdlets de trabajo, como el Stop-Job cmdlet .

El nombre descriptivo predeterminado es Job#, donde # es un número ordinal que se incrementa para cada trabajo.

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

-PSVersion

Especifica una versión de PowerShell que se va a usar para ejecutar el trabajo. Cuando el valor de PSVersion es 5.1 , el trabajo se ejecuta en una sesión de Windows PowerShell 5.1. Para cualquier otro valor, el trabajo se ejecuta con la versión actual de PowerShell.

Este parámetro se agregó en PowerShell 7 y solo funciona en Windows.

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

-RunAs32

A partir de PowerShell 7, el parámetro RunAs32 no funciona en PowerShell de 64 bits (pwsh). Si Se especifica RunAs32 en PowerShell de 64 bits, Start-Job se produce un error de excepción de terminación. Para iniciar un proceso de PowerShell de 32 bits (pwsh) con RunAs32, debe tener instalado PowerShell de 32 bits.

En PowerShell de 32 bits, RunAs32 fuerza al trabajo a ejecutarse en un proceso de 32 bits, incluso en un sistema operativo de 64 bits.

En versiones de 64 bits de Windows 7 y Windows Server 2008 R2, cuando el Start-Job comando incluye el parámetro RunAs32 , no puede usar el parámetro Credential para especificar las credenciales de otro usuario.

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

-ScriptBlock

Especifica los comandos que se ejecutarán en el trabajo en segundo plano. Para crear un bloque de script, incluya los comandos entre llaves ({}). Use la $input variable automática para acceder al valor del parámetro InputObject . Este parámetro es obligatorio.

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

-Type

Especifica el tipo personalizado para los trabajos iniciados por Start-Job. Escriba un nombre de tipo de trabajo personalizado, como PSScheduledJob para los trabajos programados o PSWorkflowJob para los trabajos de flujos de trabajo. Este parámetro no es válido para los trabajos en segundo plano estándar.

Este parámetro se introdujo en PowerShell 3.0.

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

-WorkingDirectory

Especifica el directorio de trabajo inicial del trabajo en segundo plano. Si no se especifica el parámetro , el trabajo se ejecuta desde la ubicación predeterminada. La ubicación predeterminada es el directorio de trabajo actual del autor de la llamada que inició el trabajo.

Este parámetro se introdujo en PowerShell 7.

Type:	String
Position:	Named
Default value:	$HOME on Unix (macOS, Linux) and $HOME\Documents on Windows
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

String

Puede canalizar un objeto con la propiedad Name al parámetro Name a este cmdlet. Por ejemplo, puede canalizar un objeto FileInfo desde Get-ChildItem.

Salidas

System.Management.Automation.PSRemotingJob

Este cmdlet devuelve un objeto PSRemotingJob que representa el trabajo que inició.

Notas

PowerShell incluye los siguientes alias para Start-Job:

• Todas las plataformas:
  • sajb

Para ejecutarse en segundo plano, Start-Job se ejecuta en su propia sesión en la sesión actual. Cuando se usa el Invoke-Command cmdlet para ejecutar un Start-Job comando en una sesión en un equipo remoto, Start-Job se ejecuta en una sesión de la sesión remota.

Vínculos relacionados

• about_Arrays
• about_Automatic_Variables
• about_Jobs
• about_Job_Details
• about_Remote_Jobs
• Get-Job
• Invoke-Command
• Receive-Job
• Remove-Job
• Stop-Job
• Wait-Job