Set-SPContentDeploymentPath
Sets properties of a content deployment path.
Syntax
Set-SPContentDeploymentPath
[-Identity] <SPContentDeploymentPathPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Authentication <PathAuthenticationOption>]
[-CompressionEnabled]
[-DeploySecurityInformation <SPIncludeSecurity>]
[-DeployUserNamesEnabled]
[-Description <String>]
[-DestinationCentralAdministrationURL <Uri>]
[-EventReceiversEnabled]
[-KeepTemporaryFilesOptions <TemporaryFilesOption>]
[-Name <String>]
[-PathAccount <PSCredential>]
[-PathEnabled]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-SPContentDeploymentPath cmdlet sets the properties of a content deployment path for a content deployment job.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
--------------------EXAMPLE---------------------
Get-SPContentDeploymentPath "Path 1" | Set-SPContentDeploymentPath -PathEnabled:$falseThis example sets the deployment path Path 1 to be disabled.
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 |
-Authentication
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.
| Type: | PathAuthenticationOption |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-CompressionEnabled
Turns on compression during the export.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Confirm
Prompts you for confirmation before running the cmdlet.
| 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 |
-DeploySecurityInformation
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 SharePoint Foundation 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.
| Type: | SPIncludeSecurity |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-DeployUserNamesEnabled
Specify to enable event receivers during import.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Description
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-DestinationCentralAdministrationURL
Specifies the SharePoint Central Administration URL for the destination farm.
The type must be a valid URL, in the form http://server_name.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-EventReceiversEnabled
Turns on event receivers during import.
| 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 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.
| Type: | SPContentDeploymentPathPipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-KeepTemporaryFilesOptions
Specifies that temporary files are kept after content deployment is finished.
The type must be one of the following values: Never, Always, or OnFailure.
| Type: | TemporaryFilesOption |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Name
Specifies the name of the content deployment path.
The type must be a valid name of a content deployment path; for example, DeploymentPath1.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-PathAccount
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.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-PathEnabled
Enables the content deployment path.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for