Test-SPSite

Module:

sharepoint-server

Applies to:

SharePoint Server Subscription Edition

Activates the RunTests method against a referenced SPSite object.

Syntax

Test-SPSite
    [-Identity] <SPSitePipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-RuleId <Guid>]
    [-RunAlways]
    [<CommonParameters>]

Description

The Test-SPSite cmdlet runs one or all site collection health checks on the site collection and its contents. This cmdlet reports the rules which were run and provides a summary of the results.

To run tests in repair mode, use the Repair-SPSite cmdlet.

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

Examples

--------------EXAMPLE 1------------

Test-SPSite https://<site name>/sites/testsite

This example runs all the site collection health checks on the https://<site name>/sites/testsite site collection.

--------------EXAMPLE 2------------

Test-SPSite https://<site name</sites/testsite -Rule "ee967197-ccbe-4c00-88e4-e6fab81145e1"

This example runs just the "Missing Galleries Check" on the https://<site name>/sites/testsite site collection.

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

-Identity

Specifies the URL or GUID of the site to run a test.

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

-RuleId

Specifies one specific site health rule to run.

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

-RunAlways

Forces a rule to run even if a health check was run.

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

Related Links

• Repair-SPSite