Edit

Share via

Get-Runspace

Module:
Microsoft.PowerShell.Utility Module

Gets active runspaces within a PowerShell host process.

Syntax

NameParameterSet (Default) 

Get-Runspace
    [[-Name] <String[]>]
    [<CommonParameters>]

IdParameterSet 

Get-Runspace
    [-Id] <Int32[]>
    [<CommonParameters>]

InstanceIdParameterSet 

Get-Runspace
    [-InstanceId] <Guid[]>
    [<CommonParameters>]

Description

The Get-Runspace cmdlet gets active runspaces in a PowerShell host process.

Examples

Example 1: Get runspaces

Get-Runspace

Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy
  2 Runspace2       localhost       Local         Opened        Available
  3 Runspace3       localhost       Local         Opened        Available

Example 2: Get runspace by Id

Get-Runspace -Id 2

Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  2 Runspace2       localhost       Local         Opened        Available

Example 3: Get runspace by Name

Get-Runspace -Name Runspace1

Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy

Example 4: Get runspace by InstanceId

In this example, we identify an available runspace using the Name parameter and store the return object to the variable $activeRunspace. This allows you to use the properties of the Runspace in subsequent runs of Get-Runspace.

$activeRunspace = Get-Runspace -Name Runspace1
Get-Runspace -InstanceId $activeRunspace.InstanceId

Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy

Parameters

-Id

Specifies the Id of a runspace

Parameter properties

Type:

Int32[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

IdParameterSet
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InstanceId

Specifies the instance ID GUID of a running job.

Parameter properties

Type:

Guid[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

InstanceIdParameterSet
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the Name of a runspace

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NameParameterSet
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Runspace

This cmdlet returns a Runspace. You can pipe the results of a Get-Runspace command to Debug-Runspace.