Test-SPSite
Activates the RunTests method against a referenced SPSite object.
Syntax
Default (Default)
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
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the URL or GUID of the site to run a test.
Parameter properties
| Type: | SPSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RuleId
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies one specific site health rule to run.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RunAlways
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Forces a rule to run even if a health check was run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.