Edit

Share via

Pause-SPProjectWebInstance

  • Reference
Module:
SharePointServer
Applies to:
Project Server 2013, Project Server 2016, Project Server 2019

Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server PSI or CSOM.

Syntax

Pause-SPProjectWebInstance
     [-Identity] <ProjectInstancePipeBind>
     [-AssignmentCollection <SPAssignmentCollection>]
     [<CommonParameters>]

Description

Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server Interface (PSI) or Client Server Object Model (CSOM). While in this state the database is not actually read-only and the Queue service can still write to the database, but it will not pick up any new jobs to process. This cmdlet is used to allow the queue to empty out before an administrator switches the database to read-only.

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

$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'Project Application Services'}
$instance = Get-SPProjectWebInstance -ServiceApplication $sa
Pause-SPProjectWebInstance -Identity $instance

Pauses the Project Web Server Instance in the Project Web Application Service Application.

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 the instance of Project Web App to be switched to read-only mode. It can be the unique id of the instance, the URL of the Project Web App site, the site collection object that contains the Project Web App site (an SPSite), or the Project Web App instance object itself (a PSSite).

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