Wait-FsrmStorageReport
Wait-FsrmStorageReport
Waits for a period of time or until storage reports is finished running.
Syntax
Parameter Set: Query (cdxml)
Wait-FsrmStorageReport [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Wait-FsrmStorageReport -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names of storage reports.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Timeout<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport
Examples
Example 1: Wait for a storage report
The first command starts the report named "Monthly report".
The second command waits for the report to finish running.
PS C:\> Start-FsrmStorageReport -Name "Monthly report"
PS C:\> Wait-FsrmStorageReport -Name "Monthly report"
Example 2: Wait for and stop the storage report
This example waits for the report to finish running and then stops the 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"