< Back

Stop-StorageJob

Wed Jan 30, 2019 6:04 pm

NAME Stop-StorageJob



SYNOPSIS

Stops storage job.





SYNTAX

Stop-StorageJob [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -UniqueId <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Stop-StorageJob [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]



Stop-StorageJob [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Stop-StorageJob cmdlet stops the specified storage job.





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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Name <String[]>

Specifies the name of the storage job to stop.



Required? true

Position? named

Default value none

Accept pipeline input? true(ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value none

Accept pipeline input? false

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.



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



Required? true

Position? named

Default value none

Accept pipeline input? true(ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

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









OUTPUTS









Example 1: Stop all Optimize volume jobs



PS C:\\>Stop-StorageJob -Name "Optimize Volume"



The following example stops all running Optimize Volume jobs.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816498

Get-StorageJob