.png)
Set-SPUsageDefinition
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Sets the retention period for a usage provider.
Set-SPUsageDefinition [-Identity] <SPUsageDefinitionPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DaysRetained <Int32>] [-DaysToKeepUsageFiles <Int32>] [-Enable <SwitchParameter>] [-MaxTotalSizeInBytes <Int64>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPUsageDefinitionPipeBind | Specifies the usage definition object to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition 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 | ||
| DaysRetained | Optional | System.Int32 | Specifies the number of days that usage data for the usage provider is retained in the usage service database. The default value is 14. The type must be an integer between 0 and 31. | ||
| DaysToKeepUsageFiles | Optional | System.Int32 | Specifies the number of days to keep usage file retention. The value must be less than or equal to value of the DaysRetained parameter. | ||
| Enable | Optional | System.Management.Automation.SwitchParameter | Turns on the specified usage provider. | ||
| MaxTotalSizeInBytes | Optional | System.Int64 | |||
| 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 |
Note: Detailed Description
The Set-SPUsageDefinition cmdlet sets the retention period for a specified usage provider. A usage definition object defines a specific type of usage provider.
Input Types
Return Types
-----------------EXAMPLE--------------------
Set-SPUsageDefinition -Identity "Page Requests" -DaysRetained 31
This example sets the number of days that stores page requests usage data to 31.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
