DfsrSyncInfo class

  • Article

This class provides statistical and operational information for active synchronization sessions between the local replication group member and one of its partners.

Syntax

[Dynamic, Provider("DfsrMonitorProv")]
class DfsrSyncInfo : CIM_LogicalElement
{
  string       Caption;
  string       Description;
  datetime REF InstallDate;
  string       Name;
  string       Status;
  string       SyncGuid;
  string       ConnectionGuid;
  string       MemberGuid;
  string       MemberName;
  string       PartnerGuid;
  string       PartnerName;
  string       ReplicationGroupGuid;
  string       ReplicationGroupName;
  boolean      Inbound;
  uint32       State;
  uint32       InitiationReason;
  datetime     StartTime;
  datetime     EndTime;
  uint32       UpdatesTransferred;
  uint64       BytesTransferred;
  uint32       UpdatesNotTransferred;
  uint32       UpdatesToBeTransferred;
  uint32       ConflictsGenerated;
  uint32       TombstonesGenerated;
  uint32       LastErrorCode;
  uint32       LastErrorMessageId;
  datetime     ForceReplicationEndTime;
  uint32       ForceReplicationBandwidthlevel;
};

Members

The DfsrSyncInfo class has these types of members:

Properties

The DfsrSyncInfo class has these properties.

BytesTransferred

Data type: uint64

Access type: Read-only

Qualifiers: DisplayName ("Number of Bytes Transferred")

The total number of bytes that have been transferred since the synchronization session was started.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

ConflictsGenerated

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Number of Conflicts Generated")

The total number of conflicts encountered while processing updates for this session.

This property is valid only for inbound connections.

ConnectionGuid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Connection GUID"), MaxLen (36), MinLen (36)

The unique connection identifier.

Description

Data type: string

Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedSystemElement.

EndTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Sync End Time")

The time stamp for the end of the synchronization session. If the session is still in progress, this value of this property is January 1, 1601.

ForceReplicationBandwidthlevel

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Current Force Replication bandwidth level")

The bandwidth level of the current ForceReplication operation.

ForceReplicationEndTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Current Force Replication End Time")

The time stamp for the end of the current ForceReplication operation.

Inbound

Data type: boolean

Access type: Read-only

Qualifiers: DisplayName ("Is Incoming Sync")

Indicates the direction of the flow of updates between the synchronization partner and the synchronization member; it can be inbound (coming from the partner) or outbound (going to the partner).

InitiationReason

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Initiation Reason")

The reason why the synchronization session was started. The following values are supported.

Schedule

Synchronization started according to the schedule.

Forced

Synchronization started as a response to a call to the ForceReplication method.

Paused

Pause synchronization as a response to a call to ForceReplication.

ForcedUntilSync

Synchronization started as a response to a call to ForceReplication with a value of Sync Until-In-Sync.

This property is valid only for inbound connections.

InstallDate

Data type: datetime

Access type: Read-only

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Last Error Code")

The last error code.

DFSR_E_CANNOT_CONNECT

Could not connect to the partner.

This value is returned only for inbound connections.

LastErrorMessageId

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Last Error Message ID")

The event log message identifier that corresponds to the last error code.

Success (0)

MemberGuid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Member GUID"), MaxLen (36), MinLen (36)

The local replication group member identifier.

MemberName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Member Name")

The member name. This is typically the unqualified DNS name of the local computer.

Name

Data type: string

Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

PartnerGuid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Partner GUID"), MaxLen (36), MinLen (36)

The unique identifier of the partner object.

PartnerName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Partner Name")

The partner name. This is typically the unqualified DNS name of the partner computer.

ReplicationGroupGuid

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Replication Group GUID"), MaxLen (36), MinLen (36)

The unique replication group identifier.

ReplicationGroupName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Replication Group Name")

The name of the replication group that owns the connection.

StartTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Sync Start Time")

The time stamp for the start of the synchronization session.

State

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Sync Session State")

The state of the current synchronization session.

Initialized (0)

Connecting (1)

In Progress (2)

Completed (3)

In Sync (4)

Interrupted (5)

In Error (6)

Status

Data type: string

Access type: Read-only

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

SyncGuid

Data type: string

Access type: Read-only

Qualifiers: Key, DisplayName ("Sync GUID"), MaxLen (36), MinLen (36)

The unique synchronization identifier for this operation.

TombstonesGenerated

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Number of Tombstones Generated")

The total number of tombstones encountered while processing updates for this session.

This property is valid only for inbound connections.

UpdatesNotTransferred

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Number of Updates Not Transferred")

Total number of updates in the queue for transfer in this synchronization session.

UpdatesToBeTransferred

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Number of Updates Not Transferred")

The total number of updates that need to be synchronized with the partner.

This property is valid only for inbound connections.

UpdatesTransferred

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Number of Updates Transferred")

The total number of updates that have been transferred since the synchronization session was started.

Remarks

A synchronization operation may involve more than one session to avoid being blocked on an update that has not been transferred yet.

The following state diagram illustrates the transitions between the synchronization states.

dfsr synchronization state diagram

Requirements
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
End of client support
 Windows Vista
Namespace
 Root\MicrosoftDfs
MOF
DfsRProvs.mof
DLL
DfsRWmiV2.dll

See also

CIM_LogicalElement

DFSR WMI Classes