Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Remove-SPDiagnosticsPerformanceCounter

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Removes an instance of a performance counter.

Remove-SPDiagnosticsPerformanceCounter [-Category] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Counter <String>] [-DatabaseServer <SwitchParameter>] [-Instance <String>] [-WebFrontEnd <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Category

Required

System.String

Specifies the category of performance counters to remove.

The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor.

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.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

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

Counter

Optional

System.String

Specifies the type of counter to remove. If this parameter is not specified, this cmdlet removes all performance counters of the specified category.

The type must be a valid name of counter type; for example, Requests Queued, Avg. Disk Queue Length, and % Processor Time.

DatabaseServer

Optional

System.Management.Automation.SwitchParameter

Removes the specified performance counters that are collected on the database servers in the farm.

Instance

Optional

System.String

Specifies the instance name of the performance counter to remove. If this parameter is not specified, this cmdlet removes all instances of the specified performance counter.

The type must be a valid name of a performance counter instance; for example Total_PerfCounter.

WebFrontEnd

Optional

System.Management.Automation.SwitchParameter

Removes performance counters that are collected on the front end Web servers in the farm.

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 Remove-SPDiagnosticsPerformanceCounter cmdlet removes performance counters from the collection of performance counters that are read and recorded in the usage database. This cmdlet can also be used to remove entire categories and types of counters from the collection. If either the DatabaseServer or WebFrontEnd parameters are not specified, this cmdlet removes the specified performance counters on the front end Web servers in the farm.

noteNote:

The Remove-SPDiagnosticsPerformanceCounter cmdlet is only available by using Windows PowerShell. There is no user interface.

Input Types

Return Types

------------------EXAMPLE 1------------------

Remove-SPDiagnosticsPerformanceCounter –category ASP.NET

This example removes all the counters in the category ASP.NET on front end Web servers.

------------------EXAMPLE 2------------------

Remove-SPDiagnosticsPerformanceCounter –category ASP.NET –Counter "Requests Queued"

This example removes the counters in the category ASP.NET that have requests queued on front end Web servers.

------------------EXAMPLE 3------------------

Remove-SPDiagnosticsPerformanceCounter –category Processor –counter "% Processor Time" –instance "_Total" -databaseserver

This example removes the counters of the _Total instance, with the counter % Processor Time in the category Processor on database servers.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.