Rename-SPServer
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Renames a server that is currently connected to the farm.
Rename-SPServer [-Identity] <SPServerPipeBind> -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPServerPipeBind | Specifies the original name of the server. The type must be a URL, in the form http://server_name, or a GUID, in the form 1234-4567-987gb. | ||
| Name | Required | System.String | Specifies the new name of the server. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
The Rename-SPServer cmdlet changes the name of the server for internal use within SharePoint Products. The server itself must be manually renamed.
Input Types
Return Types
------------------EXAMPLE------------------
Rename-SPServer –Identity "wfb1" –Name "WFE1"
This example changes the name of the SharePoint server wfb1 to WFE1.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: