MSFT_FSRMSettings class

Article
05/31/2018

Represents the FSRM settings.

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

Syntax

[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMSettings
{
  string  Server;
  string  FromEmailAddress;
  string  AdminEmailAddress;
  sint32  EmailNotificationLimit;
  sint32  EventNotificationLimit;
  sint32  CommandNotificationLimit;
  sint32  ReportNotificationLimit;
  sint32  ReportLimitMaxFile;
  sint32  ReportLimitMaxFileGroup;
  sint32  ReportLimitMaxOwner;
  sint32  ReportLimitMaxFilesPerFileGroup;
  sint32  ReportLimitMaxFilesPerOwner;
  sint32  ReportLimitMaxFilesPerDuplicateGroup;
  sint32  ReportLimitMaxDuplicateGroup;
  sint32  ReportLimitMaxQuota;
  sint32  ReportLimitMaxFileScreenEvent;
  sint32  ReportLimitMaxPropertyValue;
  sint32  ReportLimitMaxFilesPerPropertyValue;
  string  ReportLocationIncident;
  string  ReportLocationScheduled;
  string  ReportLocationOnDemand;
  sint32  ReportFileScreenAuditDaysSince;
  string  ReportFileScreenAuditUser[] = {};
  string  ReportFileGroupIncluded[] = {};
  string  ReportFileOwnerUser[] = {};
  string  ReportFileOwnerFilePattern = "";
  string  ReportPropertyName = "";
  string  ReportPropertyFilePattern = "";
  uint64  ReportLargeFileMinimum = 0;
  string  ReportLargeFilePattern = "";
  sint32  ReportLeastAccessedMinimum = 0;
  string  ReportLeastAccessedFilePattern = "";
  sint32  ReportMostAccessedMaximum = 0;
  string  ReportMostAccessedFilePattern = "";
  sint32  ReportQuotaMinimumUsage = 0;
  boolean ReportFileScreenAuditEnable = False;
  uint32  ReportClassificationFormat[] = {Dhtml, Xml};
  string  ReportClassificationMailTo = "";
  uint32  ReportClassificationLog[];
  string  SmtpServer;
};

Members

The MSFT_FSRMSettings class has these types of members:

Methods
Properties

Methods

The MSFT_FSRMSettings class has these methods.

Method	Description
GetActionRunLimitInterval	Gets the time that an action that uses the global run limit interval must wait before the action is run again.
SendTestEmail	Send a test email to the specified email address.
SetActionRunLimitInterval	Sets the time that an action that uses the global run limit interval must wait before the action is run again.

Properties

The MSFT_FSRMSettings class has these properties.

AdminEmailAddress

Data type: string
Access type: Read/write

The email address for the administrator. Optional.

CommandNotificationLimit

Data type: sint32
Access type: Read/write

If multiple command notifications are raised, they will only be performed if at least this many minutes have passed since the last such action was performed. Optional.

EmailNotificationLimit

Data type: sint32
Access type: Read/write

If multiple email notifications are raised, they will only be performed if at least this many minutes have passed since the last such action was performed. Optional.

EventNotificationLimit

Data type: sint32
Access type: Read/write

If multiple event notifications are raised, they will only be performed if at least this many minutes have passed since the last such action was performed. Optional.

FromEmailAddress

Data type: string
Access type: Read/write

The default email address from which email messages are sent. Optional.

ReportClassificationFormat

Data type: uint32 array
Access type: Read/write

The formats of the classification report being generated. The default value is {Dhtml, Xml}.

DHtml (1)

The report is rendered in Dynamic HTML (DHTML).

Html (2)

The report is rendered in HTML.

Text (3)

The report is rendered as a text file.

Csv (4)

The report is rendered as a comma-separated value file.

Xml (5)

The report is rendered in XML.

ReportClassificationLog

Data type: uint32 array
Access type: Read/write

An array of flag values indicating the type and content of logs generated for classification. Optional.

ClassificationsInLogFile (1)

Put classification information in the XML log file.

ErrorsInLogFile (2)

Put classification errors in the XML log file.

ClassificationsInSystemLog (4)

Put classification information in the system event log.

ErrorsInSystemLog (8)

Put classification errors in the system event log.

ReportClassificationMailTo

Data type: string
Access type: Read/write

A semicolon-separated list of email addresses. "[Admin Email]" is an acceptable email address. The default value is an empty string. Optional.

ReportFileGroupIncluded

Data type: string array
Access type: Read/write

A list of file groups to include in report. Each string must be the name of a valid file group and be less than 1KB in size. The default value is an empty list, which indicates all file groups.

ReportFileOwnerFilePattern

Data type: string
Access type: Read/write

A file pattern string that indicates which files to include in the file by owner report. The string must be less than 1KB and allows the wildcard characters * and ?. The default value is an empty string.

ReportFileOwnerUser

Data type: string array
Access type: Read/write

List of users, in "domain\user" format, to include files for in the file by owner report. Each string must be less than 1KB in size. The default value is an empty list, which indicates all users.

ReportFileScreenAuditDaysSince

Data type: sint32
Access type: Read/write

The minimum number of days since the audit event to include in the report.

ReportFileScreenAuditEnable

Data type: boolean
Access type: Read/write

True if file screen auditing is enabled. The default value is False. Optional.

ReportFileScreenAuditUser

Data type: string array
Access type: Read/write

A list of user email addresses to include audit events for. Each string must be less than 1KB in size. The default value is an empty list, which indicates all users.

ReportLargeFileMinimum

Data type: uint64
Access type: Read/write

The minimum file size to include in the large file report. The default valu is 0. Optional.

ReportLargeFilePattern

Data type: string
Access type: Read/write

A string of files to include in the file by property report. The string must be less than 1KB and allows the wildcard characters * and ?. The default value is an empty string.

ReportLeastAccessedFilePattern

Data type: string
Access type: Read/write

A string of files to include in the least frequently accessed report. The string must be less than 1KB and allows the wildcard characters * and ?. The default value is an empty string.

ReportLeastAccessedMinimum

Data type: sint32
Access type: Read/write

The minimum number of days since the report was last accessed, to include in the least frequently accessed report. The default value is 0. Optional.

ReportLimitMaxDuplicateGroup

Data type: sint32
Access type: Read/write

In a duplicate files report, the maximum number of groups of duplicate files found.

ReportLimitMaxFile

Data type: sint32
Access type: Read/write

The maximum number of files to include in a storage report.

ReportLimitMaxFileGroup

Data type: sint32
Access type: Read/write

The maximum number of file groups to include in a files by file group report.

ReportLimitMaxFileScreenEvent

Data type: sint32
Access type: Read/write

The maximum number of file screens events to include in a files by file screen audit report.

ReportLimitMaxFilesPerDuplicateGroup

Data type: sint32
Access type: Read/write

In a duplicate files report, the maximum number of files in an individual duplicate group.

ReportLimitMaxFilesPerFileGroup

Data type: sint32
Access type: Read/write

In a file by file group report, the maximum number of files in any file group.

ReportLimitMaxFilesPerOwner

Data type: sint32
Access type: Read/write

In a files by owner report, the maximum number of files in for each owner.

ReportLimitMaxFilesPerPropertyValue

Data type: sint32
Access type: Read/write

In a files by property report, the maximum number of files for each property value.

ReportLimitMaxOwner

Data type: sint32
Access type: Read/write

In a files by owner report, the maximum number owners in the report.

ReportLimitMaxPropertyValue

Data type: sint32
Access type: Read/write

In a files by property report, the maximum number of property values per report.

ReportLimitMaxQuota

Data type: sint32
Access type: Read/write

The maximum number of quotas in a quota report.

ReportLocationIncident

Data type: string
Access type: Read/write

A local or remote path to a folder. Must not exceed the value of MAX_PATH. Permissions on the folder are assumed to be set so that FSRM can write data to it.

ReportLocationOnDemand

Data type: string
Access type: Read/write

A local or remote path to a folder. Must not exceed the value of MAX_PATH. Permissions on the folder are assumed to be set so that FSRM can write data to it.

ReportLocationScheduled

Data type: string
Access type: Read/write

A local or remote path to a folder. Must not exceed the value of MAX_PATH. Permissions on the folder are assumed to be set so that FSRM can write data to it.

ReportMostAccessedFilePattern

Data type: string
Access type: Read/write

A string of files to include in the most frequently accessed report. The string must be less than 1KB and allows the wildcard characters * and ?. The default value is an empty string.

ReportMostAccessedMaximum

Data type: sint32
Access type: Read/write

The maximum number of days since the report was last accessed, to include in the least frequently accessed report. The default value is 0. Optional.

ReportNotificationLimit

Data type: sint32
Access type: Read/write

If multiple report notifications are raised, they will only be performed if at least this many minutes have passed since the last such action was performed. Optional.

ReportPropertyFilePattern

Data type: string
Access type: Read/write

A string of files to include in the file by property report. The string must be less than 1KB and allows the wildcard characters * and ?. The default value is an empty string.

ReportPropertyName

Data type: string
Access type: Read/write

The property name to report on for file by property report. The string must be a valid property name and must not exceed 1KB in size. The default value is an empty string. Optional.

ReportQuotaMinimumUsage

Data type: sint32
Access type: Read/write

The minimum quota usage level to include in the quota usage report. The default value is 0. Optional.

Server

Data type: string
Access type: Read-only
Qualifiers: key

The SMTP server that FSRM uses to send email.

SmtpServer

Data type: string
Access type: Read/write

TBD

Requirements


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

MSFT_FSRMSettings class

Syntax

Members

Methods

Properties

Requirements

See also

Additional resources