MSFT_FSRMQuota class

Article
05/31/2018

Used to define a quota for a specified directory and to retrieve use statistics.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMQuota
{
  string                  Path;
  string                  Description = "";
  uint64                  Size;
  boolean                 SoftLimit = False;
  boolean                 Disabled = False;
  string                  Template;
  boolean                 MatchesTemplate;
  uint64                  Usage;
  uint64                  PeakUsage;
  MSFT_FSRMQuotaThreshold Threshold[] = {};
};

Members

The MSFT_FSRMQuota class has these types of members:

Methods
Properties

Methods

The MSFT_FSRMQuota class has these methods.

Method	Description
Reset	Applies the property values of the specified quota template to this quota.
Update	Starts a quota scan on the specified path.

Properties

The MSFT_FSRMQuota class has these properties.

Description

Data type: string
Access type: Read/write

A string up to 1KB in size. Optional. The default value is an empty string.

Disabled

Data type: boolean
Access type: Read/write

If True, the quota is disabled. The default value is False.

MatchesTemplate

Data type: boolean
Access type: Read-only

If True, the property values of this quota match those values of the template from which it was derived.

Path

Data type: string
Access type: Read/write
Qualifiers: key

A string that represents a valid local path to a folder. Must not exceed the value of MAX_PATH. Required.

PeakUsage

Data type: uint64
Access type: Read-only

The highest amount of disk space usage charged to this quota.

Size

Data type: uint64
Access type: Read/write

The size of the quota. If the Template property is not provided then the Size property must be provided.

SoftLimit

Data type: boolean
Access type: Read/write

If True, the quota is a soft limit. If False, the quota is a hard limit. The default value is False. Optional.

Template

Data type: string
Access type: Read/write

A valid quota template name. Up to 1KB in size. Optional.

Threshold

Data type: MSFT_FSRMQuotaThreshold array
Access type: Read/write
Qualifiers: EmbeddedInstance ("MSFT_FSRMQuotaThreshold")

A list of MSFT_FSRMQuotaThreshold instances representing quota threshold objects with no more than 16 entries. The default value is an empty list.

Usage

Data type: uint64
Access type: Read-only

The current amount of disk space usage charged to this quota.

Remarks

A quota limits the amount of data that the system or any user can store in a directory.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\FSRM
MOF	MSFT_FSRM.mof
DLL	SrmSvc.dll

Share via