Export-SPSiteSubscriptionSettings

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Creates a backup file of site subscription data.

Syntax

Export-SPSiteSubscriptionSettings
      [-Identity] <SPSiteSubscriptionPipeBind>
      -Path <String>
      [-AdminProperties]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-Force]
      [<CommonParameters>]

Description

The Export-SPSiteSubscriptionSettings cmdlet generates a backup file of all settings in the subscription data store for the given site subscription.

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

Examples

--------------EXAMPLE 1-----------------

Export-SPSiteSubscriptionSettings -Identity "https://siteCollection" -Path "C:\siteCollection_sitesubscriptionsettings.txt"

The example backs up the subscription settings store of https://siteCollection.

--------------EXAMPLE 2-----------------

$site = Get-SPSite https://siteCollection
Export-SPSiteSubscriptionSettings -Identity $site.SiteSubscription -Path "C:\siteCollection_sitesubscriptionsettings.txt"

The example backs up the subscription settings store of https://siteCollection using the Site Subscription object.

Parameters

-AdminProperties

Specifies that only administrator subscription properties are exported. If this parameter is not set, only non-administrator subscription properties are exported.

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

-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

-Force

Forces the output backup file (if provided) to overwrite any existing file at the given path.

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

-Identity

Specifies the ID of the site subscription from which to back up data.

The type must be a valid URL, in the form https://server_name or a Site Subscription object.

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

-Path

Specifies the location of the output file.

The type must be a valid path; for example, C:/backupfile.back..

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

Share via