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

Show-SyncTaskStats

Use this cmdlet to show raw statistics for an actively processing SyncTask.

Show-SyncTaskStats

  • -TaskID


    Description

    Use the Show-SyncTaskStats to retrieve numeric statistics for the actions being performed by an active task. See Example #1 below for a listing of the statistics provided by this cmdlet.

    When this cmdlet is used without parameters, a simplified view is provided of the following properties: TaskID, TaskName, ItemsProcessed, and KBSourceToTarget

    Examples

    Example 1
      
    Show-SyncTaskStats -FullDetail
    TaskID                            : 335d55d1-1fc2-4f57-bc23-71c8319fa84d
    TaskName                          : Sync from [Mailbox] user@source.com to [Mailbox] user@target.com
    -------------------------------   :
    StartupProgress                   : 100
    TotalSourceFolders                : 46
    TotalTargetFolders                : 39
    TotalSourceItems                  : 392
    TotalTargetItems                  : 0
    TotalEnumeratedSourceItems        : 392
    TotalEnumeratedTargetItems        : 0
    SourceFoldersEnumerated           : 46
    TargetFoldersEnumerated           : 39
    SourceFoldersAnalyzed             : 46
    TargetFoldersAnalyzed             : 39
    SourceFoldersSkippedNotSupported  : 23
    TargetFoldersSkippedNotSupported  : 17
    FoldersProcessed                  : 0
    SourceFoldersSkipped              : 0
    TargetFoldersSkipped              : 0
    SourceFoldersCreated              : 0
    TargetFoldersCreated              : 2
    SourceFoldersMoved                : 0
    TargetFoldersMoved                : 0
    SourceFoldersUpdated              : 0
    TargetFoldersUpdated              : 2
    SourceFoldersDeleted              : 0
    TargetFoldersDeleted              : 0
    SourceItemsAnalyzed               : 275
    TargetItemsAnalyzed               : 0
    SourceContentsEnumerated          : 24
    TargetContentsEnumerated          : 19
    SourceItemsEnumerated             : 392
    TargetItemsEnumerated             : 0
    TotalItemsToProcess               : 275
    ItemsProcessed                    : 0
    ItemsCompleted                    : 0
    ItemsCopiedSourceToTarget         : 0
    ItemsCopiedTargetToSource         : 0
    ItemsCopiedVerifiedSourceToTarget : 0
    ItemsCopiedVerifiedTargetToSource : 0
    ItemsUpdatedSourceToTarget        : 0
    ItemsUpdatedTargetToSource        : 0
    ItemsNoChanges                    : 0
    ItemsDeletedInSource              : 0
    ItemsDeletedInTarget              : 0
    MapiItemActions                   : 0
    MapiActive                        : 1
    CalendarFixesCompleted            : 0
    ItemActionFailures                : 0
    ItemsSkipped                      : 0
    MsgsPerSecond-Processed           : 0
    MsgsPerSecond-Completed           : 0
    KbpsFromSource                    : 19.26
    KbpsToTarget                      : 5.98
    KbpsFromTarget                    : 6.33
    KbpsToSource                      : 14.07
    

    This example shows the many attributes of an actively running SyncTask.Note that the values provided are accurate at the time the cmdlet is executed. All values may be updated between one use of this cmdlet and the next. For information about reporting and reports for completed tasks, see the Reporting topic of the documentation.


    Parameters

    -TaskID

    The TaskID parameter specifies the SyncTask from the task queue for which to list statistics.

    If this value is not provided, statistics will be listed for all active tasks.

    Required:
    No
    Type:
    Guid
    Aliases:
    None
    Position:
    0
    Default Value:
    Guid.Empty

    -ItemCounts

    The ItemCounts switch parameter, when present, limits the output of values to item count values for convenience.

    The following values are returned with this switch:

    TotalItemsToProcess
    ItemsProcessed
    ItemsCompleted
    ItemsNoChanges
    ItemActionFailures
    ItemsSkipped

    Required:
    No
    Type:
    SwitchParameter
    Aliases:
    None
    Position:
    Not a positioned parameter. Use by name only.
    Default Value:
    False

    -TransferRates

    The TransferRates switch parameter, when present, limits the output of properties to data and item transfer rate values: KbpsFromSource, KbpsToTarget, KbpsFromTarget, KbpsToSource, MsgsPerSecond-Processed, and MsgsPerSecond-Completed.

    Note that the first time the switch is used, the values will be zero. The second and subsequent executions will calculate these values based on the duration of time that elapsed between the last call of this cmdlet.

    Required:
    No
    Type:
    SwitchParameter
    Aliases:
    None
    Position:
    Not a positioned parameter. Use by name only.
    Default Value:
    False

    -DataSizes

    The DataSizes switch parameter, when present, limits the output of properties to values that show data size values related to item processing: KBCopiedSourceToTarget, KBCopiedTargetToSource, KBUpdatedSourceToTarget, KBUpdatedTargetToSource, KBDeletedInSource, KDDeletedInTarget.

    Required:
    No
    Type:
    SwitchParameter
    Aliases:
    None
    Position:
    Not a positioned parameter. Use by name only.
    Default Value:
    False

    -FullDetail

    The FullDetail switch parameter, when present, will output all data metrics for a sync task.

    Required:
    No
    Type:
    SwitchParameter
    Aliases:
    None
    Position:
    Not a positioned parameter. Use by name only.
    Default Value:
    False

    Output

    This cmdlet places a PSObject instance on the pipeline with the properties shown in Example #1 above. The various switch parameters simply limit the initial display of values as indicated, but all properties are placed in the output object regardless of switch parameters.

    How can we help?