Clear-SPServerScaleOutDatabaseLog

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value.

Syntax

Clear-SPServerScaleOutDatabaseLog
     -Database <SPDatabasePipeBind>
     [-AssignmentCollection <SPAssignmentCollection>]
     [-Confirm]
     [-LogEntryTimeout <Int32>]
     [-WhatIf]
     [<CommonParameters>]

Description

Use the Clear-SPServerScaleOutDatabaseLog cmdlet clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value.

Examples

-----------EXAMPLE-------

$databases = Get-SPServerScaleOutDatabase -ServiceApplication $serviceApplication
$database = $databases[0]
Clear-SPServerScaleOutDatabaseLog -Database $database -LogEntryTimeout 30

This example removes all scale-out log entries in the first scale-out database of the specified service application unless there is a scale-out log entry which is more recent than 30 minutes.

Parameters

-AssignmentCollection

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.

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.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Database

Specifies the scale-out database from which to clear the logs.

Type:	SPDatabasePipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-LogEntryTimeout

Specifies the time-out value in minutes for the log entries. If there is at least one log entry which is more recent than this value, no log entries will be deleted.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Inputs

Microsoft.SharePoint.PowerShell.SPDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object

Share via