Share via


DfsrVolumeConfig class

This class stores the per-volume settings for each volume on the system that hosts one or more replicated folders.

Syntax

[Dynamic, Provider("DfsrConfigProv")]
class DfsrVolumeConfig : CIM_Setting
{
  string   Caption;
  string   Description;
  string   SettingID;
  string   VolumeGuid;
  uint64   SerialNumber;
  string   VolumePath;
  uint32   LastChangeNumber;
  datetime LastChangeTime;
  string   LastChangeSource;
  string   DatabasePath;
  uint32   MinNtfsJournalSizeInMb;
  uint32   UsnCheckPoint;
  uint32   MaxJetSessions;
  boolean  IsClustered;
  string   ClusterDiskResName;
};

Members

The DfsrVolumeConfig class has these types of members:

Methods

The DfsrVolumeConfig class has these methods.

Method Description
ResumeReplication Resumes replication for the volume.
Windows Server 2012, Windows Server 2008 R2, Windows Server 2008 and Windows Vista: This method is not supported until Windows Server 2012 R2.

Properties

The DfsrVolumeConfig class has these properties.

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.

ClusterDiskResName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Clustered Volume Physical Disk Resource Name")

If the volume is a cluster shared volume, this property specifies the physical disk resource name.

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

DatabasePath

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Database Path"), MaxLen (2600)

The full path to the database. This database contains metadata about the files and folders in the replicated folder.

Description

Data type: string

Access type: Read-only

Textual description of the CIM_Setting object.

This property is inherited from CIM_Setting.

IsClustered

Data type: boolean

Access type: Read-only

Qualifiers: DisplayName ("Is a clustered Volume")

This property is TRUE if the volume is a cluster shared volume, or FALSE if it is a local volume.

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

LastChangeNumber

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Last Change Number"), MinValue (1)

The configuration sequence number. This value is incremented each time the volume configuration changes.

LastChangeSource

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Last Change Source")

Information about the originator of the last configuration change. This is the name of the DC that provided the configuration information.

LastChangeTime

Data type: datetime

Access type: Read-only

Qualifiers: DisplayName ("Last Change Time")

The time stamp of the last configuration change.

MaxJetSessions

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Maximum number of Jet Sessions"), MinValue (16)

The maximum number of concurrent Jet database sessions for this volume. Every volume has its own database, and therefore this parameter is defined per-volume.

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

MinNtfsJournalSizeInMb

Data type: uint32

Access type: Read/write

Qualifiers: DisplayName ("Minimum USN Journal Size in MB"), Units ("MB"), MinValue (4), MaxValue (10000)

The minimum size of the journal to allocate on the volume, in megabytes. If no journal exists, the DFSR creates a new journal with the specified size; otherwise, it increases the existing journal size to this minimum size. The DFSR will not change the existing journal size if it is already larger than the new minimum size.

SerialNumber

Data type: uint64

Access type: Read-only

Qualifiers: DisplayName ("Volume Serial Number")

The volume serial number.

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.

UsnCheckPoint

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Usn Check Point"), MinValue (1)

The number of journal updates to accumulate before committing a transaction.

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: Key, DisplayName ("Volume GUID"), MaxLen (36), MinLen (36)

The unique volume identifier.

VolumePath

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Volume Path")

The volume path name.

This string has one of the following formats: "\\.\drive:" or "\\?\volume{GUID}".

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_Setting

DFSR WMI Classes