Test-SPProjectWebInstance

Reference

Module:: SharePointServer

Applies to:: Project Server 2013, Project Server 2016, Project Server 2019

Runs a suite of tests on an existing Project Web Instance.

Syntax

Test-SPProjectWebInstance
    [-Identity] <ProjectInstancePipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Rule <ProjectSiteHealthRuleName>]
    [<CommonParameters>]

Description

This cmdlet runs a suite of tests on an existing Project Web Instance. The tests are designed to verify the health status of the Project Web Instance. The cmdlet returns the set of tests as a list of Microsoft.Office.Project.Server.HealthRules objects associated with a status of type SPSiteHealthStatusType (Passed, FailedWarning, FailedError).

For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833).

Examples

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

Get-SPProjectWebInstance | Test-SPProjectWebInstance

This example runs a suite of tests on all Project Web Instances in the SharePoint Server farm.

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:	Project Server 2013, Project Server 2016, Project Server 2019

-Identity

Specifies a Project Web Instance.

Type:	ProjectInstancePipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Project Server 2013, Project Server 2016, Project Server 2019

-Rule

Type:	ProjectSiteHealthRuleName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Project Server 2013, Project Server 2016, Project Server 2019

Share via