Share via


Copy-SPSite

Makes a copy of a site collection.

Syntax

Default (Default)

Copy-SPSite
    [-Identity] <SPSitePipeBind>
    [-TargetUrl] <String>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-DestinationDatabase <SPContentDatabasePipeBind>]
    [-HostHeaderWebApplication <String>]
    [-PreserveSiteId]
    [<CommonParameters>]

Description

Use the Copy-SPSite cmdlet to make a copy of a site collection from an implied source content database to a specified destination content database.

The copy of the site collection has a new URL and a new SiteID. When you have database snapshot capabilities on a computer runningSQL Server, a temporary snapshot of the source database is created for the duration of the copy to prevent any data changes during the copy process. If you do not have database snapshot capabilities on the server running SQL Server, you can back up the source and restore it to the destination to get the same result.

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

Examples

EXAMPLE

Copy-SPSite https://contoso/sites/OldTeam -DestinationDatabase WSS_Content -TargetUrl https://contoso/sites/NewTeam

This example makes a copy of the https://contoso/sites/OldTeam site collection from its database to the WSS_Content database with the new URL, https://contoso/sites/NewTeam and a new Site ID.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, 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.

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

-DestinationDatabase

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the location where the copy will be sent to.

Parameter properties

Type:SPContentDatabasePipeBind
Default value:None
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

-HostHeaderWebApplication

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Use when the site collection is a host-named site collection that allows the site to land on the correct web application.

Parameter properties

Type:String
Default value:None
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

-Identity

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the site collection to copy. This can be a valid URL or GUID.

Parameter properties

Type:SPSitePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-PreserveSiteId

Applicable: SharePoint Server 2016, SharePoint Server 2019

Specifies if the SiteID is to be saved or not.

The valid values are True and False. The default value is False.

Parameter properties

Type:SwitchParameter
Default value:None
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

-TargetUrl

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

The URL that will be used for the destination copy of the site collection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:True
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.