Export (0) Print
Expand All
Expand Minimize

Start-SPDiagnosticsSession

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

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

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

Parameters

Parameter Required Type Description

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.

CorrelationId

Optional

System.Guid

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

Dashboard

Optional

System.Management.Automation.SwitchParameter

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

TraceLevel

Optional

System.String

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

  • High

  • Medium

  • Monitorable

  • Unexpected

  • Verbose

  • VerboseEx

  • None

Detailed 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.

Input Types

Return Types

-------------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.

Change History

Date Description

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft