Get-StorageJob

Get-StorageJob

Returns information about long-running Storage module jobs, such as a repair task.

Syntax

Parameter Set: ByStoragePool
Get-StorageJob [-AsJob] [-CimSession <CimSession[]> ] [-JobState <JobState[]> ] [-Name <String[]> ] [-StoragePool <CimInstance> ] [-ThrottleLimit <Int32> ] [-VirtualDisk <CimInstance> ] [ <CommonParameters>]

Parameter Set: BySubsystem
Get-StorageJob [-AsJob] [-CimSession <CimSession[]> ] [-JobState <JobState[]> ] [-StorageSubsystem <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ByUniqueId
Get-StorageJob [-AsJob] [-CimSession <CimSession[]> ] [-JobState <JobState[]> ] [-ThrottleLimit <Int32> ] [-UniqueId <String[]> ] [ <CommonParameters>]

Parameter Set: ByVirtualDisk
Get-StorageJob [-AsJob] [-CimSession <CimSession[]> ] [-JobState <JobState[]> ] [-Name <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-StorageJob cmdlet returns information about long-running Storage module jobs, such as a repair operation on a storage space.

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-JobState<JobState[]>

Gets storage jobs in the specified state. Acceptable values are Completed, Exception, Killed, New, QueryPending, Running, Service, ShuttingDown, Starting, Suspended, and Terminated.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies the name the storage job to get.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StoragePool<CimInstance>

Specifies the storage pool object in which to retrieve storage jobs. Enter a StoragePool CIM object. The StoragePool CIM object is exposed by the Get-StoragePool cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-StorageSubsystem<CimInstance>

Specifies the storage subsystem object in which to retrieve storage jobs. Enter a StorageSubsystem CIM object. The StorageSubsystem CIM object is exposed by the Get-StorageSubSystem cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UniqueId<String[]>

Specifies the ID of the storage job to retrieve.

Aliases	Id
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualDisk<CimInstance>

Specifies the virtual disk object for which to get storage jobs. Enter a VirtualDisk CIM object. The Virtual Disk CIM object is exposed by the Get-VirtualDisk cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool

  You can pipe an MSFT_StoragePool object to the StoragePool parameter to specify the storage pool in which to get storage jobs.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem

  You can pipe an MSFT_StorageSubsystem object to the StorageSubsystem parameter to specify the storage subsystem for which to get storage jobs.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk

  You can pipe an MSFT_VirtualDisk object to the VirtualDisk parameter to specify the virtual disk for which to get storage jobs.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageJob

  The Get-StorageJob cmdlet returns objects that represent storage jobs.

Notes

• The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

Example 1: Get all current storage jobs

This example displays a list of all current storage jobs.

PS C:\> Get-StorageJob

Example 2: Get all storage jobs on the Storage Spaces subsystem

This example gets all storage jobs on the Storage Spaces subsystem, using the Get-StorageSubSystem cmdlet to get the StorageSubsystem object.

PS C:\> Get-StorageJob -StorageSubsystem (Get-StorageSubSystem -FriendlyName "Storage Spaces*")

Related topics

Receive-Job