Export (0) Print
Expand All

Set-SPContentDeploymentPath

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Sets properties of a content deployment path.

Set-SPContentDeploymentPath [-Identity] <SPContentDeploymentPathPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Authentication <Basic | Windows>] [-CompressionEnabled <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DeploySecurityInformation <None | WssOnly | All>] [-DeployUserNamesEnabled <SwitchParameter>] [-Description <String>] [-DestinationCentralAdministrationURL <Uri>] [-EventReceiversEnabled <SwitchParameter>] [-KeepTemporaryFilesOptions <Never | Always | Failure>] [-Name <String>] [-PathAccount <PSCredential>] [-PathEnabled <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The Set-SPContentDeploymentPath cmdlet sets the properties of a content deployment path for a content deployment job.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.Publishing.Cmdlet.SPContentDeploymentPathPipeBind

Specifies the content deployment path to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content deployment job (for example; DeployPath1); or an instance of a valid SPContentDeploymentPath object.

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.

Authentication

Optional

Microsoft.SharePoint.Publishing.Administration.PathAuthenticationOption

Sets the Windows-based authentication type that the source front-end Web server uses to communicate with the destination Web application.

The type must be one of the following values: WindowsAuth or BasicAuth.

CompressionEnabled

Optional

System.Management.Automation.SwitchParameter

Turns on compression during the export.

DeploySecurityInformation

Optional

Microsoft.SharePoint.Deployment.SPIncludeSecurity

Specifies the user and group information to include during the export operation for this content deployment path. The default value is All.

The type must be one of the following values: None, All, or WssOnly- Applies only Microsoft SharePoint Foundation 2010 security settings. Includes user memberships and role assignments such as default roles, for example, Web Designer or any custom roles that extend from the default roles. The access control list (ACL) for each object is migrated. No user information defined in the DAP or LDAP servers is included.

DeployUserNamesEnabled

Optional

System.Management.Automation.SwitchParameter

Specify to enable event receivers during import.

Description

Optional

System.String

Sets the description for the content deployment path. The description can contain a maximum of 4096 alphanumeric characters.

The type must be a valid string.

DestinationCentralAdministrationURL

Optional

System.Uri

Specifies the SharePoint Central Administration URL for the destination farm.

The type must be a valid URL, in the form http://server_name.

EventReceiversEnabled

Optional

System.Management.Automation.SwitchParameter

Turns on event receivers during import.

KeepTemporaryFilesOptions

Optional

Microsoft.SharePoint.Publishing.Administration.TemporaryFilesOption

Specifies that temporary files are kept after content deployment is finished.

The type must be one of the following values: Never, Always, or OnFailure.

Name

Optional

System.String

Specifies the name of the content deployment path.

The type must be a valid name of a content deployment path; for example, DeploymentPath1.

PathAccount

Optional

System.Management.Automation.PSCredential

Specifies the user ID that is an administrator on the Central Administration page on the destination farm.

The type must be a valid SharePoint user.

PathEnabled

Optional

System.Management.Automation.SwitchParameter

Enables the content deployment path.

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

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

Get-SPContentDeploymentPath "Path 1" | Set-SPContentDeploymentPath -PathEnabled:$false

This example sets the deployment path Path 1 to be disabled.

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