Edit

Share via

Wait-FsrmStorageReport

  • Reference
Module:
FileServerResourceManager

Waits for a period of time or until storage reports is finished running.

Syntax

Wait-FsrmStorageReport
    [-Name] <String[]>
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-Timeout <Int32>]
    [-Confirm]
    [-WhatIf]
Wait-FsrmStorageReport
    [-AsJob]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-Timeout <Int32>]
    -InputObject <CimInstance[]>
    [-Confirm]
    [-WhatIf]

Description

The Wait-FsrmStorageReport cmdlet waits for a period of time or until one or more storage reports are finished running. The cmdlet returns when the server finishes running the storage reports or when the time that you specify in the Timeout parameter has elapsed.

Examples

Example 1: Wait for a storage report

PS C:\>Start-FsrmStorageReport -Name "Monthly report" PS C:\>Wait-FsrmStorageReport -Name "Monthly report"

The first command starts the report named "Monthly report".

The second command waits for the report to finish running.

Example 2: Wait for and stop the storage report

The first command starts the report named "Monthly report".
PS C:\>Start-FsrmStorageReport -Name "Monthly report"

The second command waits for the report to finish running. If the report is not completed in 10 minutes, the server ends the report job and the cmdlet returns.
PS C:\>Wait-FsrmStorageReport -Name "Monthly report" -Timeout 600

The third command ensures that the report has stopped running.
PS C:\>Stop- FsrmStorageReport -Name "Monthly report"

This example waits for the report to finish running and then stops the report.

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

-Timeout

Specifies the number of seconds to wait for reports to complete. The cmdlet returns when the period expires or the report completes. To wait indefinitely, set the value to -1. The value must be in the range from -1 through 2,147,483.

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

Outputs

CimInstance