DfsrReplicatedFolderInfo class

Article
05/31/2018

This class provides statistical and operational information for each replicated folder hosted on the local computer.

Syntax

[Dynamic, Provider("DfsrMonitorProv")]
class DfsrReplicatedFolderInfo : CIM_LogicalElement
{
  string       Caption;
  string       Description;
  datetime REF InstallDate;
  string       Name;
  string       Status;
  string       ReplicatedFolderGuid;
  string       ReplicatedFolderName;
  string       ReplicationGroupGuid;
  string       ReplicationGroupName;
  string       MemberGuid;
  string       MemberName;
  datetime     LastConflictCleanupTime;
  datetime     LastTombstoneCleanupTime;
  uint32       CurrentStageSizeInMb;
  uint32       CurrentConflictSizeInMb;
  uint8        State;
  uint32       LastErrorCode;
  uint32       LastErrorMessageId;
};

Members

The DfsrReplicatedFolderInfo class has these types of members:

Methods
Properties

Methods

The DfsrReplicatedFolderInfo class has these methods.

Method	Description
CleanupConflictDirectory	Starts the Conflict and Deleted folder cleanup process.
Fence	Applies a fence to a specific file or folder.
GetOutboundBacklogFileCount	Retrieves the number of files scheduled to be replicated to an outbound partner given its version vector.
GetOutboundBacklogFileIdRecords	Retrieves the list of files that are scheduled to be replicated to the outbound partner given its version vector.
GetStatus	This method is reserved for system use.
GetVersionVector	Retrieves the current version vector chain of this member.

Properties

The DfsrReplicatedFolderInfo class has these properties.

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.

CurrentConflictSizeInMb

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Current Conflict and Deleted Folder Size in MB"), Units ("MB")

The current size of the Conflict and Deleted folder, in MB.

CurrentStageSizeInMb

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Current Staging Folder Size in MB"), Units ("MB")

The current size of the staging folder, in MB.

Description

Data type: string
Access type: Read-only

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

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.

LastConflictCleanupTime

Data type: datetime
Access type: Read-only
Qualifiers: DisplayName ("Last Conflict Cleanup Time")

The last time the conflict cleanup process ran on this replicated folder.

LastErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Last Error Code")

The last error code.

Success (0)

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)

LastTombstoneCleanupTime

Data type: datetime
Access type: Read-only
Qualifiers: DisplayName ("Last Tombstone Cleanup Time")

The last time the tombstone cleanup process ran on this replicated folder.

MemberGuid

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Member GUID"), MaxLen (36), MinLen (36)

The GUID of the member that hosts this replicated folder.

MemberName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Member Name")

The name of the member that hosts this replicated folder.

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.

ReplicatedFolderGuid

Data type: string
Access type: Read-only
Qualifiers: Key, DisplayName ("Replicated Folder GUID"), MaxLen (36), MinLen (36)

The identifier of the local replicated folder.

ReplicatedFolderName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Replicated Folder Name")

The friendly name of the replicated folder. The name is not required to be unique.

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 contains this replicated folder.

State

Data type: uint8
Access type: Read-only
Qualifiers: DisplayName ("Replicated Folder State")

The current replicated folder state for this member.

Uninitialized (0)

Initialized (1)

Initial Sync (2)

Auto Recovery (3)

Normal (4)

In Error (5)

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")

Examples

The Get-DFSRBacklog PowerShell code sample on TechNet Gallery uses DfsrReplicatedFolderInfo to retrieve DFSR backlog for replication groups of the targeted server.

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

Share via