Set-SPServer

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2016, SharePoint Server 2019

Changes the role of the server.

Syntax

Set-SPServer
   [-Identity] <SPServerPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Role <SPServerRole>]
   [-Status <SPObjectStatus>]
   [<CommonParameters>]

Description

The Set-SPServer cmdlet changes the role of the server in the farm by using the Role parameter. A new cmdlet in SharePoint Server 2016, SharePoint Server 2019 that is used in MinRole.

Examples

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

Set-SPServer -Role SingleServerFarm

This example changes the server to SingleServerFarm role.

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.

NOTE: 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 2016, SharePoint Server 2019

-Identity

Specifies the name of the server in the farm.

Type:	SPServerPipeBind
Aliases:	Address
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2016, SharePoint Server 2019

-Role

Specifies the name of the server role you want to change.

The valid values are:

WebFrontEnd
Application
SingleServerFarm
Distributed Cache
Search
Custom
ApplicationWithSearch
WebFrontEndWithDistributedCache

Type:	SPServerRole
Accepted values:	Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2016, SharePoint Server 2019

-Status

Sets the status of the server in the farm.

Type:	SPObjectStatus
Accepted values:	Online, Disabled, Offline, Unprovisioning, Provisioning, Upgrading, Patching
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.SharePoint.PowerShell.SPServerPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object

Share via