Set-QADProgressPolicy
From PowerGUI Wiki
Set the user preference on whether to display a progress bar for long-running commands.
This cmdlet is part of the Quest ActiveRoles Server product. Use Get-QARSProductInfo to view information about ActiveRoles Server.
Contents |
Syntax
Set-QADProgressPolicy [-ShowProgress <bool>] [-Threshold <int>] [<CommonParameters>]
Detailed Description
Use this cmdlet to specify whether you want the QAD and QARS cmdlets that support the ShowProgress parameter, to display a progress bar by default. When performing a lengthy operation (that is, an operation that lasts longer than a certain threshold time), such a cmdlet may display a progress bar to depict the status of the operation. Whether a progress bar is displayed, depends upon the ShowProgress setting. A threshold time can be set by using the Threshold parameter. These settings only affect the current user, and can be overridden on a per-cmdlet basis.
Note that the progress bar feature is based on the Write-Progress function that was first introduced in version 2.0 of Windows PowerShell. With Windows PowerShell 1.0 this feature is not available.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ShowProgress | Use this parameter to specify whether you want QAD and QARS cmdlets to display a progress bar that depicts the status of the running command in case of a lengthy operation. This setting has an effect only on the cmdlets that support the ShowProgress and ProgressThreshold parameters to control the appearance of a progress bar.
The ShowProgress setting of TRUE causes a cmdlet that supports the ShowProgress parameter to display a progress bar, even if the ShowProgress parameter is omitted. The ShowProgress setting of FALSE suppresses a progress bar unless the ShowProgress parameter is supplied. | false | false | |
| Threshold | Use this parameter to set the default delay, in seconds, before a cmdlet that performs a lengthy operation displays a progress bar to depict the status of the running command. If the running command finishes before the threshold time has elapsed, a progress bar does not appear. This threshold time setting is used as the default threshold time setting by the QAD and QARS cmdlets that support the ShowProgress and ProgressThreshold parameters to control the appearance of a progress bar. | false | false |
Examples
EXAMPLE 1
Set-QADProgressPolicy -ShowProgress $true -ProgressThreshold 2 | Out-Null
Description
Set the user preference for the progress bar appearance policy, to cause a progress bar to appear by default when a command takes longer than 2 seconds to finish.
