Export-SPWeb2

The Export-SPWeb2 cmdlet exports a site collection, Web application, list, or library. This cmdlet extends the capabilities of the Export-SPWeb cmdlet by exposing additional parameters.

Export-SPWeb2 -Identity <SPWebPipeBind> [-CompressionSize [<Int32>]] [-IncludeDependencies [<SwitchParameter>]] [-ExcludeChildren [<SwitchParameter>]] [-IncludeVersions [<SPIncludeVersions>]] [-IncludeDescendants [<SPIncludeDescendants>]] [-ItemUrl [<String>]] [-UseSqlSnapshot [<SwitchParameter>]] [-Force [<SwitchParameter>]] [-HaltOnError [<SwitchParameter>]] [-HaltOnWarning [<SwitchParameter>]] [-IncludeUserSecurity [<SwitchParameter>]] [-NoFileCompression [<SwitchParameter>]] [-NoLogFile [<SwitchParameter>]] -Path <String> [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
IdentityTrueSPWebPipeBind

Specifies the URL or GUID of the Web to be exported.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

CompressionSizeFalseInt32

Sets the maximum file size for the compressed export files. If the total size of the exported package is greater than this size, the exported package will be split into multiple files.

IncludeDependenciesFalseSwitchParameter

ExcludeChildrenFalseSwitchParameter

IncludeVersionsFalseSPIncludeVersions

Indicates the type of file and list item version history to be included in the export operation. If the IncludeVersions parameter is absent, the cmdlet by default uses a value of "LastMajor".

The type must be any one of the following versions:

-Last major version for files and list items (default)

-The current version, either the last major version or the last minor version

-Last major and last minor version for files and list items

-All versions for files and list items

IncludeDescendantsFalseSPIncludeDescendants

ItemUrlFalseString

Specifies the URL of the Web application, GUID, or object to be exported.

The type must be a valid URL; for example, http://server_name.

UseSqlSnapshotFalseSwitchParameter

Specifies a SQL Database Snapshot will be created when the export process begins, and all exported data will be retrieved directly from the database snapshot. This snapshot will be automatically deleted when export completes.

ForceFalseSwitchParameter

Forcefully overwrites the export package if it already exists.

HaltOnErrorFalseSwitchParameter

Stops the export/import process when an error occurs.

HaltOnWarningFalseSwitchParameter

Stops the export/import process when a warning occurs.

IncludeUserSecurityFalseSwitchParameter

Preserves the user security settings.

NoFileCompressionFalseSwitchParameter

Either enables or disables file compression in the export package. The export package is stored in the folder specified by thePath parameter or Identity parameter. We recommend that you use this parameter for performance reasons. If compression is enabled, the export process can increase by approximately 30 percent.

NoLogFileFalseSwitchParameter

Suppresses the generation of an export log file. If this parameter is not specified, the cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS).

It is recommended to use this parameter. However, for performance reasons, you might not want to generate a log file.

PathTrueString

Specifies the name of the export file.

If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid.

AssignmentCollectionFalseSPAssignmentCollection

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.

Detailed Description

The Export-SPWeb2 cmdlet exports a site collection, Web application, list, or library. This cmdlet extends the capabilities of the Export-SPWeb cmdlet by exposing additional parameters.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples