Export (0) Print
Expand All

Set-SPSiteUrl

SharePoint 2013
 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Adds or changes an URL mapping for the site.

Set-SPSiteUrl [-Identity] <SPSitePipeBind> -Url <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Zone <Default | Intranet | Internet | Custom | Extranet>]

The Set-SPSiteUrl cmdlet adds or changes an URL mapping for the site.

The Set-SPSiteUrl cmdlet only applies to the root site collection for a host name that is, http://www.contoso.com. This cmdlet cannot be directly run against a managed path site collection underneath the root that is, http://www.contoso.com/sites/test.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPSitePipeBind

Specifies the URL or GUID of the site collection to set. Must be the root site collection for a host-name.

Url

Required

System.String

Specifies the URL. This must be unique. This must be an absolute URL including scheme (that is, https://www.contoso.com). If URL exists, the current entry is updated. Otherwise, the URL entry is added and cannot be in use by another site collection.

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.

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

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

Zone

Optional

Microsoft.SharePoint.Administration.SPUrlZone

Specifies one of the five zones with which the alternate URL is associated.

The type must be any one of the following values:

  • Default

  • Intranet

  • Internet

  • Custom

  • Extranet

If the Zone parameter is not specified and is a new entry, the default value is set. If an entry exists and is not specified, do not change.

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

$site = Get-SPSite 'http://www.contoso.com'
Set-SPSiteURL -Identity $site -Url http://contoso.sharepoint.com -Zone Default

This example adds an additional URL, http://contoso.sharepoint.com, to the site collection. The newly added URL is in the default zone.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft