Wait-FsrmClassification
Wait-FsrmClassification
Waits for a period of time or until classification is finished running.
Syntax
Parameter Set: Wait1
Wait-FsrmClassification [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Wait-FsrmClassification cmdlet waits for a period of time or until classification is finished running. The cmdlet returns when the server finishes running the classification process 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 |
-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 classification and the reports to complete. The cmdlet returns when the period expires or classification 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? |
True (ByPropertyName) |
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_FSRMClassification
Examples
Example 1: Wait for a classification
The first command starts the classification.
The second command waits for the classification to finish running.
PS C:\> Start-FsrmClassification
PS C:\> Wait-FsrmClassification
Example 2: Wait for and stop the classification
This example waits for the classification to finish running and then stops the classification.
The first command starts the classification process.
PS C:\> Start-FsrmClassification
The second command waits for the classification to finish running. If the classification is not completed in 10 minutes, the server ends the classification process and the cmdlet returns.
PS C:\> Wait-FsrmClassification -Timeout 600
The third command ensures that the classification has stopped running.
PS C:\> Stop-FsrmClassification