Share via

Set-SPServer

Module:
SharePointServer module

Changes the role of the server.

Syntax

Default (Default) 

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

Applicable: 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.

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.

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

Specifies the name of the server in the farm.

Parameter properties

Type:SPServerPipeBind
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Address

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Role

Applicable: SharePoint Server 2016, SharePoint Server 2019

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

The valid values are:

  • WebFrontEnd
  • Application
  • SingleServerFarm
  • Distributed Cache
  • Search
  • Custom
  • ApplicationWithSearch
  • WebFrontEndWithDistributedCache

Parameter properties

Type:SPServerRole
Default value:None
Accepted values:Application, ApplicationWithSearch, Custom, DistributedCache, Search, SingleServerFarm, WebFrontEnd, WebFrontEndWithDistributedCache
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

-Status

Applicable: SharePoint Server 2016, SharePoint Server 2019

Sets the status of the server in the farm.

Parameter properties

Type:SPObjectStatus
Default value:None
Accepted values:Online, Disabled, Offline, Unprovisioning, Provisioning, Upgrading, Patching
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.

Inputs

Microsoft.SharePoint.PowerShell.SPServerPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object