Remove-SPUsageApplication
Published: July 16, 2012
Applies to: SharePoint Server 2013 Standard
Removes a usage application from the local farm.
Remove-SPUsageApplication [-Identity] <SPUsageApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-RemoveData <SwitchParameter>] [-UsageService <SPUsageServicePipeBind>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPUsageApplicationPipeBind | Specifies the usage application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. | ||
| 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 | ||
| RemoveData | Optional | System.Management.Automation.SwitchParameter | Specifies that the logging database is also removed. | ||
| UsageService | Optional | Microsoft.SharePoint.PowerShell.SPUsageServicePipeBind | Reserved for future use. | ||
| 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-SPUsageApplication cmdlet deletes a usage application from the local farm.
Input Types
Return Types
-------------------EXAMPLE--------------------
Remove-SPUsageApplication –Identity "Usage and Health data collection" –RemoveData
This example removes the existing usage application and the associated logging DB.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: