DfsrReplicatedFolderConfig class

Article
05/31/2018

An instance of this class is available for each replicated folder that this hosted on this computer. This class provides read-only access to the configuration parameters for the replicated folder.

Syntax

[Dynamic, Provider("DfsrConfigProv")]
class DfsrReplicatedFolderConfig : CIM_Setting
{
  string  Caption;
  string  SettingID;
  string  ReplicatedFolderGuid;
  string  ReplicatedFolderName;
  string  ReplicatedFolderDn;
  string  ReplicationGroupGuid;
  string  MemberGuid;
  string  VolumeGuid;
  string  RootPath;
  uint32  RootSizeInMb;
  string  StagingPath;
  uint32  StagingSizeInMb;
  string  ConflictPath;
  uint32  ConflictSizeInMb;
  string  FileFilter;
  string  DirectoryFilter;
  boolean Ghosted;
  boolean CacheObeyConnectionSchedule;
  uint32  MinAgeInCacheInMin;
  uint32  MaxAgeInCacheInMin;
  boolean Enabled;
  boolean IsPrimary;
  boolean ReadOnly;
  boolean DisableSaveDeletes;
  boolean DisableReanimateDeletes;
  boolean SharedStaging;
  boolean CompressedExtensions;
  string  Description;
  uint64  UsnCreated;
  string  ContainerComputerName;
  boolean IsClustered;
  string  VcoResourceName;
};

Members

The DfsrReplicatedFolderConfig class has these types of members:

Methods
Properties

Methods

The DfsrReplicatedFolderConfig class has these methods.

Method	Description
Offline	This method is reserved for system use.
Online	This method is reserved for system use.

Properties

The DfsrReplicatedFolderConfig class has these properties.

CacheObeyConnectionSchedule

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Obey Connection Schedule In Cache")

Obey the connection schedule for on-demand replication.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short textual description of the CIM_Setting object.

This property is inherited from CIM_Setting.

CompressedExtensions

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("File extensions that are compressed")

File extensions that are compressed, contain the * wildcard, are empty strings, or are comma-separated extensions.

ConflictPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Conflict and Deleted Folder Path"), MaxLen (2600)

The local path of the Conflict and Deleted folder for the replicated folder.

ConflictSizeInMb

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Conflict and Deleted Folder Quota In MB"), MinValue (10)

The quota size of the Conflict and Deleted folder assigned to the replicated folder, in megabytes.

ContainerComputerName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Content Set AD computer name")

The name of the Active Directory computer object that holds the replicated folder information. Normally this name is same as the NETBIOS name of the local computer.

Windows Vista and Windows Server 2008: This property is not supported until Windows Server 2008 R2.

Description

Data type: string
Access type: Read-only

The user-defined description of the content or purpose of the current replicated folder.

DirectoryFilter

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Subfolder Exclusion Filter"), MaxLen (2600)

The directory exclusion filter list. A comma-separated list of filter strings to be applied to subfolders under the local path of the replicated folder.

DisableReanimateDeletes

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Disable Reanimation of Remote Deletions")

Indicates whether remote deletions should be reanimated.

DisableSaveDeletes

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Disable Saving Deletes")

Disables the feature that moves deleted files to the Conflict and Deleted folder.

Enabled

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Replicated Folder Status")

Indicates whether this replicated folder is enabled. DFSR will ignore disabled replicated folder; however, they will remain in the configuration files.

FileFilter

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("File Exclusion Filter"), MaxLen (2600)

The file exclusion filter list. This is a comma-separated list of filter strings to be applied to files under the local path of the replicated folder.

Ghosted

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Ghosted Content")

This property is not used.

IsClustered

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Is content set part of a VCO")

This property is TRUE if the Active Directory server that holds the replicated folder is a virtual computer in a cluster, or FALSE if it is a local computer.

Windows Vista and Windows Server 2008: This property is not supported until Windows Server 2008 R2.

IsPrimary

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Is Primary")

Indicates whether the data in the replicated folder is authoritative during the initial synchronization operation.

MaxAgeInCacheInMin

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Maximum Age Time In Cache In Minutes"), MinValue (0)

Reserved for system use.

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.

MinAgeInCacheInMin

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Minimum Age Time In Cache In Minutes"), MinValue (0)

Minimum time a candidate ghosted resource remains un-ghosted before it is considered for ghosting.

ReadOnly

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Read-only")

Indicates whether this replicated folder is read-only.

ReplicatedFolderDn

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

The distinguished name of the corresponding object in the Active Directory Domain Services.

ReplicatedFolderGuid

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

The unique identifier for the 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 GUID of the replication group that contains this replicated folder.

RootPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Local Path"), MaxLen (2600)

The full path to the replicated folder.

RootSizeInMb

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Root Quota In MB"), MinValue (10)

The quota size of the root folder, in megabytes, assigned to the replicated folder.

SettingID

Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

Identifier by which the CIM_Setting object is known.

This property is inherited from CIM_Setting.

SharedStaging

Data type: boolean
Access type: Read-only
Qualifiers: DisplayName ("Shared Staging Folder")

Specifies whether the staging folder is private or shared.

StagingPath

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Staging Folder Path"), MaxLen (2600)

The full path to the staging folder for the replicated folder.

StagingSizeInMb

Data type: uint32
Access type: Read-only
Qualifiers: DisplayName ("Staging Quota In MB"), MinValue (10)

The maximum size of the staging space assigned to the replicated folder, in megabytes. Note that DFSR can allow the staging space to exceed this value temporarily.

UsnCreated

Data type: uint64
Access type: Read-only
Qualifiers: DisplayName ("Replicated Folder USN Created")

The USN-created value of the object that represents the replicated folder in Active Directory.

Windows Vista and Windows Server 2008: This property is not supported until Windows Server 2008 R2.

VcoResourceName

Data type: string
Access type: Read-only
Qualifiers: DisplayName ("Content Set VCO Resource Name")

If the replicated folder is configured against a virtual computer, this property specifies the Network Name resource of the clustered replicated folder.

Windows Vista and Windows Server 2008: This property is not supported until Windows Server 2008 R2.

VolumeGuid

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

The GUID of the volume that contains the replicated folder.

Examples

The Get-DFSRBacklog PowerShell code sample on TechNet Gallery uses DfsrReplicatedFolderConfig 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

DfsrReplicatedFolderConfig class

Syntax

Members

Methods

Properties

Examples

Requirements

See also

Additional resources