Export (0) Print
Expand All

New-SPContentDeploymentJob

SharePoint 2013
 

Applies to: SharePoint Server 2013 Enterprise

Topic Last Modified: 2013-12-18

Creates a content deployment job.

New-SPContentDeploymentJob -Name <String> -SPContentDeploymentPath <SPContentDeploymentPathPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-EmailAddresses <String[]>] [-EmailNotifications <None | SendEmailOnFailure | SendEmailOnSuccess | SendEmailOnAlways>] [-HostingSupportEnabled <SwitchParameter>] [-IncrementalEnabled <SwitchParameter>] [-Schedule <String>] [-ScheduleEnabled <SwitchParameter>] [-Scope <SPWebPipeBind[]>] [-SqlSnapshotSetting <None | CreateNew>] [-WhatIf [<SwitchParameter>]]

The New-SPContentDeploymentJob cmdlet adds a new content deployment job to a farm.

 

Parameter Required Type Description

Name

Required

System.String

Specifies the name of the new content deployment job.

The type must be a valid name of a content deployment job; for example, DeployJob1.

SPContentDeploymentPath

Required

Microsoft.SharePoint.Publishing.Cmdlet.SPContentDeploymentPathPipeBind

Specifies the deployment path to associate with the new deployment job.

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; DeployJob1); or an instance of a valid SPContentDeploymentJob 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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Description

Optional

System.String

Specifies the description for the content deployment job. The name can be a maximum of 4096 alphanumeric characters.

The type must be a valid string.

EmailAddresses

Optional

System.String[]

Specifies the e-mail addresses of individuals who receive notification e-mails about this ContentDeploymentJob object.

The type must be a list of valid e-mail addresses.

EmailNotifications

Optional

Microsoft.SharePoint.Publishing.Administration.ContentDeploymentNotificationSettings

Specifies how e-mail notifications are sent about this ContentDeploymentJob object.

The type must be one of the following:

-Never specifies that e-mail notifications will not be sent when a job succeeds or fails.

- SendEmailOnSuccess specifies that e-mail notifications will be sent if a content deployment job succeeds.

- SendEmailOnFailure specifies that e-mail notifications will be sent if a content deployment job fails.

- SendEmailOnAlways specifies that e-mail notifications will be sent when a job succeeds or fails.

HostingSupportEnabled

Optional

System.Management.Automation.SwitchParameter

Enables special hosting- behavior. The default value is False.

Normally, a content deployment job is enabled or disabled by using the SharePoint Central Administration Web site. However, in the case of hosting, the tenant administrator does not have permissions to access the Central Administration page to configure jobs. Therefore, when the HostingSupportEnabled parameter is set to True, the hoster creates the job, so that tenants can enable or disable their deployment jobs from their tenant administration site.

IncrementalEnabled

Optional

System.Management.Automation.SwitchParameter

Specifies that only incremental changes are deployed to the destination site collection.

Schedule

Optional

System.String

Sets the schedule for the deployment job.

The type must be a valid SPSchedule object.

ScheduleEnabled

Optional

System.Management.Automation.SwitchParameter

Specifies to enable the schedule for the deployment job. If the schedule is not enabled the job can be run only manually.

Scope

Optional

Microsoft.SharePoint.PowerShell.SPWebPipeBind[]

Sets the scope of the deployment job. SPSites passed in must exist in the current path of the source site collection. The default scope is the entire site collection. Valid values include an SPWeb object or an array of SPWeb objects.

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

SqlSnapshotSetting

Optional

Microsoft.SharePoint.Publishing.Administration.ContentDeploymentSqlSnapshotSetting

Creates a database snapshot of the source SharePoint Foundation 2013 content database to use for the export process.

The type must be one of the following values:

- None

- CreateNew

NoteNote:
The CreateNew value requires thatSQL Server Enterprise Edition be installed.

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" | New-SPContentDeploymentJob -Name "Deployment Job" -SPContentDeploymentPath $_ -IncrementalEnabled:$true -ScheduleEnabled:$false

This example creates a new content deployment job called Deployment Job by using the deployment path Path 1. The job is configured to be an incremental job with no schedule.

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