Edit

Share via

Start-SPDiagnosticsSession

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Starts a diagnostic session to report diagnostic information to the usage database.

Syntax

Start-SPDiagnosticsSession
     [-AssignmentCollection <SPAssignmentCollection>]
     [-CorrelationId <Guid>]
     [-Dashboard]
     [-TraceLevel <String>]
     [<CommonParameters>]

Description

Use the Start-SPDiagnosticsSession cmdlet to report diagnostic information to the usage database. After a diagnostic session starts, all Windows PowerShell for SharePoint cmdlets in Windows PowerShell scripts will use the same correlation to report diagnostic information.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

$correlationId = [guid]::NewGuid()
Start-SPDiagnosticsSession -CorrelationId $correlationId -Dashboard:$true -TraceLevel Verbose

This example starts a diagnostic session for a specified correlation ID with the trace level of verbose.

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

-CorrelationId

Specifies the correlation ID to be used for the diagnostic session.

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

-Dashboard

Specifies that diagnostics behave as if the developer dashboard were enabled.

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

-TraceLevel

Specifies the Unified Logging Service (ULS) trace level override.

--High --Medium --Monitorable --Unexpected --Verbose --VerboseEx --None

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