PowerShell Commands

Get-StorageJob

Get-StorageJob [-CimSession <CimSession[]>] [-JobState <JobState[]>] [-ThrottleLimit <Int32>] [-UniqueId<String[]>] [<CommonParameters>]
Get-StorageJob [-CimSession <CimSession[]>] [-JobState <JobState[]>] [-Name <String[]>] [-StoragePool<CimInstance>] [-ThrottleLimit <Int32>] [-VirtualDisk <CimInstance>] [<CommonParameters>]
Get-StorageJob [-CimSession <CimSession[]>] [-JobState <JobState[]>] [-StorageSubsystem <CimInstance>][-ThrottleLimit <Int32>] [<CommonParameters>]
Get-StorageJob [-CimSession <CimSession[]>] [-JobState <JobState[]>] [-Name <String[]>] [-ThrottleLimit <Int32>][<CommonParameters>]
Get-StorageJob [-Disk <CimInstance>] [<CommonParameters>]
Get-StorageJob [-Volume <CimInstance>] [<CommonParameters>]

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

Parameters

-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.

-Disk [<CimInstance>]

  • Accepts pipeline input ByValue

Specifies a disk for which to get storage jobs. To obtain a Disk object, use the Get-Disk cmdlet.

-JobState [<JobState[]>]

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

-Name [<String[]>]

Specifies the name the storage job to get.

-StoragePool [<CimInstance>]

  • Accepts pipeline input ByValue

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.

-StorageSubsystem [<CimInstance>]

  • Accepts pipeline input ByValue

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.

-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 PowerShellr 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.

-UniqueId [<String[]>]

  • Accepts pipeline input ByPropertyName

Specifies the ID of the storage job to retrieve.

-VirtualDisk [<CimInstance>]

  • Accepts pipeline input ByValue

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.

-Volume [<CimInstance>]

  • Accepts pipeline input ByValue

Specifies the volume object for which to get storage jobs. To obtain a Volume object, use the Get-Volume cmdlet.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool
http://msdn.microsoft.com/library/windows/desktop/hh830551.aspx 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 http://msdn.microsoft.com/library/windows/desktop/hh830569.aspx 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 http://msdn.microsoft.com/library/windows/desktop/hh830584.aspx You can pipe an MSFT_VirtualDisk object to the VirtualDisk parameter to specify the virtual disk for which to get storage jobs.
Outputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageJob
http://msdn.microsoft.com/library/windows/desktop/hh830545.aspx The Get-StorageJob cmdlet returns objects that represent storage jobs.
Examples
  1. Get all current storage jobs:
    PS C:\> Get-StorageJob
    
       Name                  ElapsedTime           JobState              PercentComplete       IsBackgroundTask
       ----                  -----------           --------              ---------------       ----------------
       Regeneration          00:00:00              Running               50                    True

    This example displays a list of all current storage jobs.

  2. Get all storage jobs on the Windows Storage subsystem:
    PS C:\> Get-StorageJob -StorageSubsystem (Get-StorageSubSystem -FriendlyName "Storage Spaces*")
    

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

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands