Category Archives: Modules

Set-FsrmSetting

Parameter Name Description
AdminEmailAddress Specifies a semicolon-separated list of email addresses for the recipients of any email that the server sends to the administrator.
CommandNotificationLimit Specifies the minimum number of seconds between individual running events of a command-type notification. If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action.
EmailNotificationLimit Specifies the minimum number of seconds between individual running events of an email-type notification. If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action.
EventNotificationLimit Specifies the minimum number of seconds between individual running events of an event-type notification. If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action.
FromEmailAddress Specifies the default email address from which FSRM sends email messages.
ReportClassificationFormat Specifies an array of formats of classification reports that the server generates. The acceptable values for this parameter are:?
— DHTML
— HTML
— XML
— CSV
— Text
ReportClassificationLog Specifies an array of types of logs that the File Classification Infrastructure can generate during classification. The acceptable values for this parameter are:?
— None
— ClassificationsInLogFile
— ErrorsInLogFile
— ClassificationsInSystemLog
— ErrorsInSystemLog
ReportClassificationMailTo Specifies a semicolon-separated list of email addresses. The server sends the classification reports to the email addresses after a scheduled classification is complete.
ReportFileGroupIncluded Specifies an array of names of file groups to include in the report. Each string must be the name of a valid file group.
ReportFileOwnerFilePattern Specifies a file pattern string that indicates which files to include in the file by owner report. You can use the wildcard characters * and ? in the string.
ReportFileOwnerUser Specifies an array of users, in Domain\User format, to include files for in the file by owner report. The default value is an empty list, which indicates all users.
ReportFileScreenAuditDaysSince Specifies the minimum number of days since the audit event to include in the report.
ReportFileScreenAuditEnable Indicates that file screen auditing is enabled.
ReportFileScreenAuditUser Specifies an array of user email addresses to include audit events for. The default value is an empty list, which indicates all users.
ReportLargeFileMinimum Specifies the minimum file size to include in the large file report.
ReportLargeFilePattern Specifies a string of files to include in the large file report. You can use the wildcard characters * and ? in the string.
ReportLeastAccessedFilePattern Specifies a string of files to include in the least frequently accessed report. You can use the wildcard characters * and ? in the string.
ReportLeastAccessedMinimum Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report.
ReportLimitMaxDuplicateGroup Specifies the maximum number of groups of duplicate files to include in the duplicate files report.
ReportLimitMaxFile Specifies the maximum number of files to include in a storage report.
ReportLimitMaxFileGroup Specifies the maximum number of file groups to include in a file group report.
ReportLimitMaxFileScreenEvent Specifies the maximum number of file screens events to include in a file screen audit report.
ReportLimitMaxFilesPerDuplicateGroup Specifies the maximum number of files in an individual duplicate group to include in a duplicate files report.
ReportLimitMaxFilesPerFileGroup Specifies the maximum number of files in any file group to include in a file group report.
ReportLimitMaxFilesPerOwner Specifies the maximum number of files for any owner to include in a files by owner report.
ReportLimitMaxFilesPerPropertyValue Specifies the maximum number of files for each property value to include in a files by property report.
ReportLimitMaxOwner Specifies the maximum number of owners to include in a files by owner report.
ReportLimitMaxPropertyValue Specifies the maximum number of property values to include in a files by property report.
ReportLimitMaxQuota Specifies the maximum number of quotas to include in a quota usage report.
ReportLocationIncident Specifies a path to a folder where the server stores incident reports.
ReportLocationOnDemand Specifies a path to a folder where the server stores on demand reports.
ReportLocationScheduled Specifies a path to a folder where the server stores scheduled reports.
ReportMostAccessedFilePattern Specifies a string of files to include in the most frequently accessed report. You can use the wildcard characters * and ? in the string.
ReportMostAccessedMaximum Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report.
ReportNotificationLimit Specifies the minimum number of seconds between individual running events of a report notification. If multiple report notifications occur, the server runs the report notification only if at least this amount of time have passed since the server last performed this action.
ReportPropertyFilePattern Specifies a string of files to include in the file by property report. You can use the wildcard characters * and ? in the string.
ReportPropertyName Specifies the property name to report on for a file by property report.
ReportQuotaMinimumUsage Specifies the minimum quota usage level to include in the quota usage report.
SmtpServer Specifies the fully qualified domain name (FQDN) or IP address of the SMTP server that FSRM uses to send email.

 

New-FsrmAction

Parameter Name Description
Body Specifies the content of an email. If you specify this parameter, you must set Email or Event Specify for the Type parameter.
Command Specifies the full path to the program or script. If you specify this parameter, you must set Command for the Type parameter.
CommandParameters Specifies the parameters for the program or script. If you specify this parameter, you must set Command for the Type parameter.
EventType Specifies the event type of the action. If you specify this parameter, you must set Event for the Type parameter. The acceptable values for this parameter are:?
— None
— Information
— Warning
— Error
KillTimeOut Specifies the timeout period, in minutes, after which the process that the action created is ended. Specify the default, -1, to indicate that the server does not end the process. If you specify this parameter, you must set Command for the Type parameter.
MailBCC Specifies a semicolon-separated list of email addresses for the Bcc recipients of an email. Valid email addresses are an administrator email account or the owner of the file. If you specify this parameter, you must set Email for the Type parameter.
MailCC Specifies a semicolon-separated list of email addresses for the Cc recipients of an email. Valid email addresses are an administrator email account or the owner of the file. If you specify this parameter, you must set Email for the Type parameter.
MailTo Specifies a semicolon-separated list of email addresses for the recipients of an email. Valid email addresses are an administrator email account or the owner of the file. If you specify this parameter, you must set Email for the Type parameter.
ReportTypes Specifies an array of report types that the action generates. If you specify this parameter, you must set Report for the Type parameter. The acceptable values for this parameter are:?
— DuplicateFiles
— FilesByFileGroup
— FilesByOwner
— FilesByProperty
— LargeFiles
— LeastRecentlyAccessed
— MostRecentlyAccessed
— QuotaUsage
RunLimitInterval Specifies the minimum interval, in minutes, before the server can run the action again. For example, if the interval expired since the action last ran, the server runs the action again in response to an event; otherwise, the server cannot run the action again. The default value, 60, specifies that there is no limit.
SecurityLevel Specifies the computer account type under which the program or script runs. The acceptable values for this parameter are:?
— LocalService
— NetworkService
— LocalSystem
ShouldLogError Indicates that the server records errors codes from running commands in the event log.
Subject Specifies the subject of an email. The maximum size of a subject is 1 KB. If you specify this parameter, you must set Email for the Type parameter.
Type Specifies the type of the action. This setting determines the action that the server takes in response to a quota or file screen event. The acceptable values for this parameter are:?
— Email
— Event
— Command
— Report
WorkingDirectory Specifies the working directory in which the program or script runs. You must specify a valid path to a folder. FSRM does not support paths to remote computers.

 

New-FsrmStorageReport

Parameter Name Description
FileGroupIncluded Specifies an array of names of file groups to include in the report. Each string must be the name of a valid file group.
FileOwnerFilePattern Specifies a string of files to include in the file by owner report. You can use the wildcard characters * and ? in the string. If you specify this parameter, you must set FilesByOwner for the ReportType parameter.
FileOwnerUser Specifies an array of users, in Domain\User format, to include files for in the file by owner report. The default value is an empty list, which indicates all users.
FileScreenAuditUser Specifies an array of user email addresses to include audit events for. The default value is an empty list, which indicates all users. If you specify this parameter, you must set FileScreenAuditFiles for the ReportType parameter.
FolderPropertyName Specifies a name of the classification property name to report on for a folder by property report. Specify the value of the Name property in an FsrmClassificationPropertyDefinition object. If you specify this parameter, you must set FoldersByProperty for the ReportType parameter.
Interactive Indicates that the report is interactive. When you specify this parameter, the report does not require a schedule, the report cannot be modified, the report is generated immediately when you run this cmdlet, and the server removes the report automatically from the system when it finishes running the report.
LargeFileMinimum Specifies the minimum file size to include in the large file report. If you specify this parameter, you must set LargeFiles for the ReportType parameter.
LargeFilePattern Specifies a string of files to include in the large file report. You can use the wildcard characters * and ? in the string. If you specify this parameter, you must set LargeFiles for the ReportType parameter.
LeastAccessedFilePattern Specifies a string of files to include in the least frequently accessed report. You can use the wildcard characters * and ? in the string. If you specify this parameter, you must set LeastRecentlyAccessed for the ReportType parameter.
LeastAccessedMinimum Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report. If you specify this parameter, you must set LeastRecentlyAccessed for the ReportType parameter.
MailTo Specifies a semicolon-separated list of email addresses for the recipients of an email. [Admin Email] is a valid email address.
MostAccessedFilePattern Specifies a string of files to include in the most frequently accessed report. You can use the wildcard characters * and ? in the string. If you specify this parameter, you must set MostRecentlyAccessed for the ReportType parameter.
MostAccessedMaximum Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report. If you specify this parameter, you must set MostRecentlyAccessed for the ReportType parameter.
Name Specifies a name for the storage report. If you do not specify a name, the server generates a standard name. You must specify this parameter if you specify the Interactive parameter.
Namespace Specifies an array of namespaces that are part of the scope of the report. Each string must be either a value of the FolderType property on the server, the string “All Shares”, or a static path. The FolderType properties must be in the format [Folder type property name=<value>].
PropertyFilePattern Specifies a string of files to include in the file by property report. You can use the wildcard characters * and ? in the string. If you specify this parameter, you must set FilesByProperty for the ReportType parameter.
PropertyName Specifies the name of the classification property to report on for a file by property report. Specify the value of the Name property in an FsrmClassificationPropertyDefinition object. If you specify this parameter, you must set FilesByProperty for the ReportType parameter.
QuotaMinimumUsage Specifies the minimum quota usage level to include in the quota usage report. If you specify this parameter, you must set QuotaUsage for the ReportType parameter.
ReportFormat Specifies an array of report formats that the classification report produces. The acceptable values for this parameter are:?
— DHTML
— HTML
— XML
— CSV
— Text
ReportType Specifies the types of reports that the action generates. Specify this parameter only if you set the Type parameter to Report.The acceptable values for this parameter are:?
— DuplicateFiles
— FilesByFileGroup
— FilesByOwner
— FilesByProperty
— LargeFiles
— LeastRecentlyAccessed
— MostRecentlyAccessed
— QuotaUsage
Schedule Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for running the storage report. Use the New-FsrmScheduledTask cmdlet to create a scheduled task object.

 

Set-FsrmClassificationRule

Parameter Name Description
ClassificationMechanism Specifies the name of a valid classification mechanism available on the server for assigning the property value.
ContentRegularExpression Specifies an array of regular expressions for pattern matching.
ContentString Specifies an array of strings for the content classifier to search for.
ContentStringCaseSensitive Specifies an array of content sensitive strings for the content classifier to search for.
Description Specifies a description for the classification rule.
Disabled Indicates that the classification rule is disabled.
Flags Specifies an array of flags that define the possible states of the rule.
Name Specifies an array of names of classification rules.
Namespace Specifies an array of namespaces where the rule is applied. Each value must be either a value of the FolderType property defined on the server (in the format “[Folder type property name=<value>]”) or a static path.
Parameters Specifies an array of strings using the format <name>=<value>. The File Classification Infrastructure and other management tools use these parameters.
Property Specifies the name of a classification property definition to set. Specify the value of the Name property in an FsrmClassificationPropertyDefinition object.
PropertyValue Specifies the property value that the rule will assign. The property value that you set must be a valid value supported by the classification mechanism that you specify in the ClassificationMechanism parameter.
ReevaluateProperty Specifies the evaluation policy of the rule. The acceptable values for this parameter are:?
— Never: Assign values to properties only if that property does not already have a value for the file.
— Overwrite: Reclassify files when the files change and overwrite this property.
— Aggregate: Reclassify files when the files change and aggregate the new value for the property with the existing value.

Set-FsrmFileScreenTemplate

Parameter Name Description
Active Indicates that the server fails any I/O operation that violates the file screen. If you do not specify this parameter, the server does not fail violating I/O operations and still runs any action that is associated with the file screen.
Description Specifies a description for the file screen template.
IncludeGroup Specifies an array of names of file groups that you want to exclude from file screening.
Name Specifies the name of a file screen template.
Notification Specifies an array of notification action objects. You can use the New-FsrmFmjNotificationAction cmdlet to create a FsrmFmjNotificationAction object.
UpdateDerived Indicates that the server modifies all existing file screens that were created with the original file screen template. If you specify this parameter, you cannot specify the UpdateDerivedMatching parameter.
UpdateDerivedMatching Indicates that the server updates only the file screens that you have not modified since you created them with the original file screen template. If you specify this parameter, you cannot specify the UpdateDerived parameter.

 

New-FsrmFileManagementJob

Parameter Name Description
Action Specifies a FsrmFmjAction object. You can use the New-FsrmFmjAction cmdlet to create a FsrmFmjAction object.
Condition Specifies a FsrmFmjCondition object. You can use the New-FsrmFmjCondition cmdlet to create a FsrmFmjCondition object.
ContinuousLog Indicates that the server maintains a log of continuous classification activities. You must specify the Continuous parameter to log classification activities.
ContinuousLogSize Specifies the maximum size of the log that contains continuous classification activity. You must specify the Continuous parameter to log classification activities.
Description Specifies a description for the file management job.
Disabled Indicates that the file management job is disabled.
MailTo Specifies a semicolon-separated list of email addresses to which the file server sends the email.
Name Specifies a name for the file management job.
Namespace Specifies an array of namespaces that are part of the scope. Each value must be either a value of the FolderType property defined on the server (in the format “[Folder type property name=<value>]”) or a static path.
Notification Specifies a FsrmFmjNotificationAction object. You can use the New-FsrmFmjNotificationAction cmdlet to create a FsrmFmjNotificationAction object.
Parameters Specifies an array of strings of the form <name>=<value>. The File Classification Infrastructure and other management tools use these parameters.
ReportFormat Specifies an array of report formats that the file management job produces. The acceptable values for this parameter are:?
— DHTML
— HTML
— XML
— CSV
— Text
ReportLog Specifies an array of report types that the file management job generates. The acceptable values for this parameter are:?
— Information
— Error
— Audit
Schedule Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for performing the continuous classification. Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. Any duration information in the FSRM scheduled task object is ignored.