Edit

Share via

Set-SPSiteURL

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Adds or changes an URL mapping for the site.

Syntax

Set-SPSiteURL
   [-Identity] <SPSitePipeBind>
   -Url <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-WhatIf]
   [-Zone <SPUrlZone>]
   [<CommonParameters>]

Description

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.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

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

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

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:SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Identity

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

Type:SPSitePipeBind
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Url

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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Zone

Specifies one of the five zones with which the alternate URL is associated. 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.

Type:SPUrlZone
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition