Set-SPContentDeploymentJob

Sets properties of a content deployment job.

Syntax

Set-SPContentDeploymentJob
   [-Identity] <SPContentDeploymentJobPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-Description <String>]
   [-EmailAddresses <String[]>]
   [-EmailNotifications <ContentDeploymentNotificationSettings>]
   [-HostingSupportEnabled]
   [-IncrementalEnabled]
   [-Name <String>]
   [-Schedule <String>]
   [-ScheduleEnabled]
   [-Scope <SPWebPipeBind[]>]
   [-SqlSnapshotSetting <ContentDeploymentSqlSnapshotSetting>]
   [-WhatIf]
   [<CommonParameters>]

Description

The Set-SPContentDeploymentJob cmdlet sets the properties of a content deployment job.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

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

C:\PS>Get-SPContentDeploymentJob "Job 1" | Set-SPContentDeploymentJob -Schedule "hourly between 0 and 59" -ScheduleEnabled:$true

This example sets the deployment job called Job 1 to run hourly.

Required Parameters

-Identity

Specifies the content deployment job 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, DeployJob1); or an instance of a valid SPContentDeploymentJob object.

Type:SPContentDeploymentJobPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016

Optional 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Description

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-EmailAddresses

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.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-EmailNotifications

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.

  • Success specifies that e-mail notifications will be sent if a content deployment job succeeds.
  • Failure specifies that e-mail notifications will be sent if a content deployment job fails.
  • Always specifies that e-mail notifications will be sent when a job succeeds or fails.
Type:ContentDeploymentNotificationSettings
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-HostingSupportEnabled

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-IncrementalEnabled

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Name

Specifies the name of the new content deployment job.

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

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Schedule

Sets the schedule for the deployment job.

The type must be a valid SPSchedule object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-ScheduleEnabled

Enables the schedule for the deployment job. If the schedule is not enabled, the job can be run manually only.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Scope

Sets the scope of the deployment job. SPSite objects that are passed in must exist in the current path of the source site collection. The default scope is the entire site collection. Valid values include a 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 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

Type:SPWebPipeBind[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-SqlSnapshotSetting

Backs up the SharePoint Foundation content database by using SQL Server.

The type must be one of the following values: None or CreateNew.

Type:ContentDeploymentSqlSnapshotSetting
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016