1. Home
  2. Docs
  3. Super-ExMerge On-line Doc...
  4. PowerShell Cmdlet Referen...
  5. Add-SyncTask

Add-SyncTask

Use the Add-SyncTask cmdlet to add a task object to the Super-ExMerge task queue. Sync tasks can be created with the New-SyncTask cmdlet.

Add-SyncTask

  • -SyncTask
  • [-TaskName]

Description

This cmdlet adds a SyncTask object to the task queue for processing.  Note that you can only add a number of sync tasks to the task queue that will not exceed the quantity of the currently applied license.

The tasks in the task queue are ordered internally by the ‘QueuePosition’ property of the sync task.  Tasks can also have a ‘StartOnOrAfter’ date in order to provide a deferred start.

Examples

Example 1
  Add-SyncTask -SyncTask $task

This example simply adds the task object to the task queue. The TaskName will be calculated from the task’s ‘Source’ and ‘Target’ properties.

Example 2
  add-SyncTask -SyncTask $task -TaskName "My Sync Task"

This example adds a task to the task queue and sets a TaskName for the task. Note that TaskName values are not required to be unique.


Parameters

-SyncTask

The SyncTask parameter is the task object that is to be added to the task queue.

Required:
Yes
Type:
SyncTask
Aliases:
None
Position:
0
Default Value:
None

-TaskName

A custom name for the task. This names appears in reports and in cmdlet output. If this value is not supplied, a default name is calculated from the task’s ‘Source’ and ‘Target’ properties.

Required:
No
Type:
String
Aliases:
None
Position:
1
Default Value:
None

Output

This cmdlet does not place any data on the pipeline.

How can we help?