Windows PowerShell command on Get-command Get-StorageJob

NAME

Get-StorageJob

SYNOPSIS

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

SYNTAX

Get-StorageJob [-CimSession ] [-JobState ] [-ThrottleLimit ] [-UniqueId

] []

Get-StorageJob [-CimSession ] [-JobState ] [-Name ] [-StoragePool

] [-ThrottleLimit ] [-VirtualDisk ] []

Get-StorageJob [-CimSession ] [-JobState ] [-StorageSubsystem ]

[-ThrottleLimit ] []

Get-StorageJob [-CimSession ] [-JobState ] [-Name ] [-ThrottleLimit ]

[]

Get-StorageJob [-Disk ] []

Get-StorageJob [-Volume ] []

DESCRIPTION

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

on a storage space.

PARAMETERS

-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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Disk []

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

Required? false Position? named Default value none Accept pipeline input? true(ByValue) Accept wildcard characters? false

-JobState []

Gets storage jobs in the specified state. Acceptable values are Completed, Exception, Killed, New, QueryPending, Running, Service, ShuttingDown, Starting, Suspended, and Terminated. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Name []

Specifies the name the storage job to get. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-StoragePool []

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.

Required? false Position? named Default value none Accept pipeline input? True (ByValue) Accept wildcard characters? false

-StorageSubsystem []

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.

Required? false Position? named Default value none Accept pipeline input? True (ByValue) Accept wildcard characters? false

-ThrottleLimit []

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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-UniqueId []

Specifies the ID of the storage job to retrieve. Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-VirtualDisk []

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.

Required? false Position? named Default value none Accept pipeline input? True (ByValue) Accept wildcard characters? false

-Volume []

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

cmdlet. Required? false Position? named Default value none Accept pipeline input? true(ByValue) Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

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.

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

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