Set-SPWebApplicationHttpThrottlingMonitor
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application.
Set-SPWebApplicationHttpThrottlingMonitor [-Identity] <SPWebApplicationPipeBind> [-Category] <String> [-Counter] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-HealthScoreBuckets <Double[]>] [-Instance <String>] [-IsDESC <SwitchParameter>] [-LowerLimit <Double>] [-UpperLimit <Double>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind | Specifies the SharePoint Web application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object. | ||
| Category | Required | System.String | Specifies the name of the performance counter category. The type must be a valid performance counter category in the throttling monitor. Use the Get-SPWebApplicationHttpThrottlingMonitor cmdlet to return a list of performance counter categories in the throttling monitor. | ||
| Counter | Required | System.String | Specifies the name of the performance counter. The type must be a valid performance counter in the throttling monitor. Use the Get-SPWebApplicationHttpThrottlingMonitor cmdlet to return a list of performance counters in the throttling monitor. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| HealthScoreBuckets | Optional | System.Double[] | Specifies bucket ranges to use in determining the calculation of the server Health Score for this counter. | ||
| Instance | Optional | System.String | Specifies the instance of the performance counter. The default value is empty. If the specified value is invalid, this cmdlet will not run. | ||
| IsDESC | Optional | System.Management.Automation.SwitchParameter | Specifies that this counter is interpreted in descending order. If this parameter is set, Health Score bucket values are interpreted in descending order; for example, set this parameter by using the Memory category and Available Mbytes counter to monitor available memory. | ||
| LowerLimit | Optional | System.Double | Specifies the lower limit of the numerical threshold of the specified performance counter. The lower limit is the lowest value in the Health Score bucket values. | ||
| UpperLimit | Optional | System.Double | Specifies the upper limit of the numerical threshold of the specified performance counter. The upper limit is the highest value in the Health Score bucket values. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
The Set-SPWebApplicationHttpThrottlingMonitor cmdlet sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application.
Input Types
Return Types
------------------EXAMPLE 1------------------
$buckets=(2000,1000,500,300,200,100,50,30,20,10)Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint -Category Memory -Counter 'Available Mbytes' -IsDesc -HealthScoreBuckets $buckets
This example sets the Health Score bucket values for the Memory\Available Mbytes counter to the array listed for the http://sharepoint Web application.
------------------EXAMPLE 2------------------
Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint0 -Category Memory -Counter 'Available Mbytes' -IsDesc -UpperLimit 3000
This example sets the upper limit for the Memory\Available Mbytes counter, the highest value in the Health Score buckets, to 3000 for the http://sharepoint Web application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: