Stop-FsrmStorageReport
Stops the running instance of storage reports.
Syntax
Stop-FsrmStorageReport
[-Name] <String[]>
[-AsJob]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-Confirm]
[-WhatIf]
Stop-FsrmStorageReport
[-AsJob]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
-InputObject <CimInstance[]>
[-Confirm]
[-WhatIf]
Description
The Stop-FsrmStorageReport cmdlet stops the running instance of one or more storage reports on the server. This cmdlet returns one of the following values for the running status of the file management job:
- NotRunning
- Queued
- Running
This cmdlet returns a success status in the following conditions:
- The server is not running the report job.
- The server is currently canceling the report job.
- The server is running the report job and has started cancellation of the report job.
- The server has removed the report job from the queue.
This cmdlet returns a failure status if the server cannot stop a storage report job that the server is running or has queued.
Examples
Example 1: Stop a storage report
PS C:\>Start-FsrmFileManagementJob "Expire stale data" PS C:\>Stop-FsrmFileManagementJob "Expire stale data"
This first command starts the storage report named "Expire stale data".
The second command stops the storage report job named "Expire stale data".
Parameters
-AsJob
ps_cimcommon_asjob
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: | CimInstance[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies an array of names of storage reports.
Type: | String[] |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-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 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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |