MSFT_FSRMStorageReport class
Represents a storage report.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMStorageReport
{
string Name;
string Namespace[];
boolean Interactive;
uint32 ReportType[];
uint32 FileScreenAuditDaysSince = 0;
string FileScreenAuditUser[] = {};
string FileGroupIncluded[] = {};
string FileOwnerUser[] = {};
string FileOwnerFilePattern = "";
string PropertyName = "";
string FolderPropertyName = "";
string PropertyFilePattern = "";
uint64 LargeFileMinimum = 0;
string LargeFilePattern = "";
uint32 LeastAccessedMinimum = 0;
string LeastAccessedFilePattern = "";
uint32 MostAccessedMaximum = 0;
string MostAccessedFilePattern = "";
uint32 QuotaMinimumUsage;
uint32 ReportFormat[] = {Dhtml, Xml};
string MailTo = "";
string LastError;
uint32 Status;
datetime LastRun;
string LastReportPath;
MSFT_FSRMScheduledTask Schedule;
};
Members
The MSFT_FSRMStorageReport class has these types of members:
Methods
The MSFT_FSRMStorageReport class has these methods.
| Method | Description |
|---|---|
| Start | Starts the generation of the provided storage report on the server. |
| Stop | Stops the execution of the provided storage report on the server. |
| Wait | Waits for the report to complete its execution. |
Properties
The MSFT_FSRMStorageReport class has these properties.
-
FileGroupIncluded
-
-
Data type: string array
-
Access type: Read/write
A list of valid file groups to include in the report. Each string must be less than 1KB. Total size must be under 25KB. Optional. The default value is an empty list, which indicates all users.
-
-
FileOwnerFilePattern
-
-
Data type: string
-
Access type: Read/write
A string of file pattern files to include in the file by owner report. The string must be less than 1KB and allow wildcard characters * and ?. Optional. The default value is an empty string.
-
-
FileOwnerUser
-
-
Data type: string array
-
Access type: Read/write
A list of users in "domain\user" format to include files for in the file by owner report. Each string must be less than 1KB. Total size must be under 25KB. The default value is an empty list, which indicates all users.
-
-
FileScreenAuditDaysSince
-
-
Data type: uint32
-
Access type: Read/write
The minimum number of days since the audit event to include in the report. Default is 0.
-
-
FileScreenAuditUser
-
-
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. Total size must be under 25KB. Optional. The default value is an empty list, which indicates all users.
-
-
FolderPropertyName
-
-
Data type: string
-
Access type: Read/write
A valid property name to report on for the file by property report. String must be less than 1KB. Optional. The default value is an empty string.
-
-
Interactive
-
-
Data type: boolean
-
Access type: Read/write
Specifies whether the report is interactive (generated immediately) or will have a schedule for running the report. If this property is True, the report is interactive and the Schedule property should be empty.
When this property is True,
- The report will not require a schedule
- The report cannot be modified
- The report is started once created
- These reports are automatically removed from the system once completed.
-
-
LargeFileMinimum
-
-
Data type: uint64
-
Access type: Read/write
The minimum file size to include in the large file report. The default value is 0. Optional.
-
-
LargeFilePattern
-
-
Data type: string
-
Access type: Read/write
A string of file pattern files to include in the large file report. The string must be less than 1KB and allow wildcard characters * and ?. Optional. The default value is an empty string.
-
-
LastError
-
-
Data type: string
-
Access type: Read-only
The error message from the last time this storage report was run.
-
-
LastReportPath
-
-
Data type: string
-
Access type: Read-only
The path of the last report run.
-
-
LastRun
-
-
Data type: datetime
-
Access type: Read-only
When the storage report was last run.
-
-
LeastAccessedFilePattern
-
-
Data type: string
-
Access type: Read/write
A string of file pattern files to include in the least frequently accessed file report. The string must be less than 1KB and allow wildcard characters * and ?. Optional. The default value is an empty string.
-
-
LeastAccessedMinimum
-
-
Data type: uint32
-
Access type: Read/write
The minimum number of days since last accessed to include in least frequently accessed report. The default value is 0. Optional.
-
-
MailTo
-
-
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, which indicates not to send an email.
-
-
MostAccessedFilePattern
-
-
Data type: string
-
Access type: Read/write
A string of file pattern files to include in the least frequently accessed file report. The string must be less than 1KB and allow wildcard characters * and ?. Optional. The default value is an empty string.
-
-
MostAccessedMaximum
-
-
Data type: uint32
-
Access type: Read/write
The maximum number of days since last accessed to include in least frequently accessed report. The default value is 0. Optional.
-
-
Name
-
-
Data type: string
-
Access type: Read/write
-
Qualifiers: key
A string up to 1KB in length. If not specified, a standard name will be generated. Required if the Interactive property is specified.
-
-
Namespace
-
-
Data type: string array
-
Access type: Read/write
An array of strings representing valid local paths to folders or valid values for the FolderUsage classification property. If providing FolderUsage properties, the format "[FolderUsage_MS=value]" must be used. Each string must not exceed the length of MAX_PATH. Required.
-
-
PropertyFilePattern
-
-
Data type: string
-
Access type: Read/write
A string of file pattern files to include in the file by property report. The string must be less than 1KB and allow wildcard characters * and ?. Optional. The default value is an empty string.
-
-
PropertyName
-
-
Data type: string
-
Access type: Read/write
A valid property name to report on for the file by property report. String must be less than 1KB. Optional. The default value is an empty string.
-
-
QuotaMinimumUsage
-
-
Data type: uint32
-
Access type: Read/write
The minimum quota usage level to include in quota usage report. The default value is 0. Optional.
-
-
ReportFormat
-
-
Data type: uint32 array
-
Access type: Read/write
The formats of the classification report being generated. No duplicates can be in the array, and the array length must be greater than 0. The default value is V{Dhtml, Xml}.
-
-
DHtml (1)
-
The report is in Dynamic HTML format.
-
Html (2)
-
The report is in HTML format.
-
Text (3)
-
The report is in text format.
-
Csv (4)
-
The report is in CSV format.
-
Xml (5)
-
The report is in XML.
ReportType
-
Data type: uint32 array
-
Access type: Read/write
An array describing the report types. No duplicates in the array are allowed. The array must have a length greater than 0. Required.
LargeFiles (1)
Lists files that are larger than a specified size. Set the filter value to the size, in bytes.
FilesByFileGroup (2)
Lists groups of files. Create a file group and use file name patterns to specify the members of the group. Set the filter value to the name of the file group.
LeastRecentlyAccessed (3)
Lists files that have not been accessed in the last n days. Specify the filter value in days.
MostRecentlyAccessed (4)
Lists files that have been accessed in the last n days. Specify the filter value in days.
QuotaUsage (5)
Lists quotas that exceed the specified threshold. Set the filter value to the threshold.
FilesByOwner (6)
Lists files grouped by their owner. Set the filter value to the list of owners whose files you want included in the report.
DuplicateFiles (8)
Lists duplicate files. All files with the same file name, file size, and last modify time under the scope of the report job are considered duplicates. For example, if the scope of the report is C:\ and D:\ and file file1.txt exists in C:\folder1\, C:\folder2\ and D:\folder1\ with the same modify time and file size, then the files are considered duplicates.
FileScreenAuditFiles (9)
Lists file screening events that have occurred.
FilesByProperty (10)
Lists files, grouped by property value, that contain the specified property (you can specify only one property on which to report).
FoldersByProperty (13)
Lists folders, grouped by property value, that contain the specified property (you can specify only one property on which to report).
Schedule
-
Data type: MSFT_FSRMScheduledTask
-
Access type: Read/write
-
Qualifiers: EmbeddedInstance ("MSFT_FSRMScheduledTask")
An MSFT_FSRMScheduledTask instance that represents the schedule for this storage report job. Required if the Interactive property is False, and must be empty if the Interactive property is True.
Status
-
Data type: uint32
-
Access type: Read-only
The current status of the report.
NotRunning (1)
The report is not running.
Queued (2)
The report has been queued.
Running (3)
The report is running.
Examples
For an example see Scheduling a Storage Report using WMI.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\FSRM |
| MOF |
|
| DLL |
|