Skip to main content

FSRM Quotas

FSRM Quotas

Plugin: windows.plugin Module: GetFSRMQuota

Maintained by Netdata

Overview​

This collector monitors File Server Resource Manager (FSRM) quotas on Windows: space used, the highest usage recorded, the quota limit, and whether each quota is disabled, a soft limit, or still matches its template.

It queries the MSFT_FSRMQuota WMI class in the root\Microsoft\Windows\FSRM namespace on its own thread, so a slow WMI service cannot delay other Windows collectors.

This collector is only supported on the following platforms:

  • windows

This collector only supports collecting metrics from a single instance of this integration.

The Netdata service account needs read access to the root\Microsoft\Windows\FSRM WMI namespace. The default LocalSystem account has it; whether other accounts can read quotas has not been verified.

Default Behavior​

Auto-Detection​

The module is disabled by default. Once enabled, it charts every quota the FSRM provider returns. Quotas created later appear on the next collection; deleted quotas stop being charted.

Limits​

Every quota is charted individually, with two charts per quota. Hosts with thousands of quotas create a matching number of charts.

Performance Impact​

Each collection runs one WMI query. If the query fails, the module retries with exponential backoff, up to every 10 minutes, so a host without the FSRM role costs almost nothing.

Setup​

Prerequisites​

FSRM role installed​

The File Server Resource Manager role service must be installed and the SrmSvc service running. Quotas are optional: with none configured, the module reports zero quotas.

Enable the module​

Set GetFSRMQuota = yes in the [plugin:windows] section of netdata.conf and restart Netdata.

Configuration​

Options​

OptionDescriptionDefaultRequired
update everyData collection frequency.10no

via File​

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows:GetFSRMQuota] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
option1 = some value
option2 = some other value

[section2]
option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
Examples​

There are no configuration examples.

Alerts​

There are no alerts configured by default for this integration.

Metrics​

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

A failed WMI query leaves a gap in every chart instead of reporting zeros.

Per FSRM Quotas instance​

These metrics refer to all FSRM quotas on the host.

This scope has no labels.

Metrics:

MetricDescriptionDimensionsUnit
fsrm.quotasFSRM quotasquotasquotas

Per quota​

These metrics refer to one FSRM quota.

Labels:

LabelDescription
pathThe folder or volume path the quota applies to.
templateThe quota template the quota was created from; empty when none.

Metrics:

MetricDescriptionDimensionsUnit
fsrm.quota_spaceFSRM quota spaceused, peak, limitbytes
fsrm.quota_stateFSRM quota statedisabled, soft_limit, matches_templatestatus

Live Data​

View every FSRM quota, including its description, which is not kept as a chart label.

FSRM Quotas​

Shows the quotas from the latest successful collection with usage, limit, peak usage, percentage used, and state. Returns an error when no collection has succeeded within three collection intervals.

AspectDescription
NameGetfsrmquota:fsrm-quotas
Require Cloudno
PerformanceReads the in-memory result of the latest collection; it does not query WMI.
SecurityRequires signed-in, same-space access because quota paths and descriptions can contain user-entered text.
AvailabilityAvailable after the first successful collection with the module enabled.

Prerequisites​

No additional configuration is required.

Parameters​

This function has no parameters.

Returns​

One row per quota; unavailable values are empty.

ColumnTypeUnitVisibilityDescription
PathstringQuota path.
TemplatestringQuota template; empty when none.
DescriptionstringQuota description.
UsednumberbytesDisk space charged to the quota.
LimitnumberbytesQuota size.
PeaknumberbyteshiddenHighest usage charged to the quota.
Used%number%Usage as a percentage of the quota size.
SoftLimitstringyes for a soft limit, no for a hard limit.
Disabledstringyes when the quota is disabled.
MatchesTemplatestringhiddenyes when the quota properties match its template.

Troubleshooting​

Known Errors​

GetFSRMQuota: the FSRM service (SrmSvc) is not running (service state state; 0 means not installed or not accessible); skipping this cycle​

Cause

The File Server Resource Manager service is stopped, still starting, not installed, or its state cannot be read by the Netdata service account. While it is not running, the FSRM WMI provider answers with an empty or incomplete list instead of an error, so the module leaves a gap in the charts rather than reporting zero quotas.

Fix

Run Get-Service SrmSvc. If the service is not found, install the FSRM role with Install-WindowsFeature FS-Resource-Manager (Windows Server). If it exists but is not running, start it with Start-Service SrmSvc and check its startup type. If it is running but the state is 0, the Netdata service account lacks permission to query it; run Netdata as LocalSystem. Charts resume on the next successful collection.

Other Problems​

No FSRM charts after enabling the module​

Check the Netdata collector log for GetFSRMQuota errors. FSRM WMI provider not found means the FSRM role is not installed; access denied means the service account cannot read the FSRM WMI namespace; timed out means the WMI service did not answer in time. A host with no quotas shows only the quota count chart, at 0.


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.