Export (0) Print
Expand All
Expand Minimize

Set-FsrmSetting

Updated: December 6, 2012

Applies To: Windows Server 2012

Set-FsrmSetting

Changes global FSRM settings for the computer.

Syntax

Parameter Set: InputObject (cdxml)
Set-FsrmSetting [-AdminEmailAddress <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-CommandNotificationLimit <Int32> ] [-EmailNotificationLimit <Int32> ] [-EventNotificationLimit <Int32> ] [-FromEmailAddress <String> ] [-InputObject <CimInstance[]> ] [-PassThru] [-ReportClassificationFormat <FsrmReportClassificationFormatEnum[]> ] [-ReportClassificationLog <FsrmReportClassificationLogEnum[]> ] [-ReportClassificationMailTo <String> ] [-ReportFileGroupIncluded <String[]> ] [-ReportFileOwnerFilePattern <String> ] [-ReportFileOwnerUser <String[]> ] [-ReportFileScreenAuditDaysSince <Int32> ] [-ReportFileScreenAuditEnable] [-ReportFileScreenAuditUser <String[]> ] [-ReportLargeFileMinimum <UInt64> ] [-ReportLargeFilePattern <String> ] [-ReportLeastAccessedFilePattern <String> ] [-ReportLeastAccessedMinimum <Int32> ] [-ReportLimitMaxDuplicateGroup <Int32> ] [-ReportLimitMaxFile <Int32> ] [-ReportLimitMaxFileGroup <Int32> ] [-ReportLimitMaxFileScreenEvent <Int32> ] [-ReportLimitMaxFilesPerDuplicateGroup <Int32> ] [-ReportLimitMaxFilesPerFileGroup <Int32> ] [-ReportLimitMaxFilesPerOwner <Int32> ] [-ReportLimitMaxFilesPerPropertyValue <Int32> ] [-ReportLimitMaxOwner <Int32> ] [-ReportLimitMaxPropertyValue <Int32> ] [-ReportLimitMaxQuota <Int32> ] [-ReportLocationIncident <String> ] [-ReportLocationOnDemand <String> ] [-ReportLocationScheduled <String> ] [-ReportMostAccessedFilePattern <String> ] [-ReportMostAccessedMaximum <Int32> ] [-ReportNotificationLimit <Int32> ] [-ReportPropertyFilePattern <String> ] [-ReportPropertyName <String> ] [-ReportQuotaMinimumUsage <Int32> ] [-SmtpServer <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-FsrmSetting cmdlet changes global File Server Resource Manager (FSRM) settings for the computer.

Parameters

-AdminEmailAddress<String>

Specifies a semicolon-separated list of email addresses for the recipients of any email that the server sends to the administrator.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CommandNotificationLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EmailNotificationLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EventNotificationLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FromEmailAddress<String>

Specifies the default email address from which FSRM sends email messages.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportClassificationFormat<FsrmReportClassificationFormatEnum[]>

Specifies an array of formats of classification reports that the server generates. The acceptable values for this parameter are: 
-- DHTML
-- HTML
-- XML
-- CSV
-- Text


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportClassificationLog<FsrmReportClassificationLogEnum[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportClassificationMailTo<String>

Specifies a semicolon-separated list of email addresses. The server sends the classification reports to the email addresses after a scheduled classification is complete.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileGroupIncluded<String[]>

Specifies an array of names of file groups to include in the report. Each string must be the name of a valid file group.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileOwnerFilePattern<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileOwnerUser<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileScreenAuditDaysSince<Int32>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileScreenAuditEnable

Indicates that file screen auditing is enabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportFileScreenAuditUser<String[]>

Specifies an array of user email addresses to include audit events for. The default value is an empty list, which indicates all users.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLargeFileMinimum<UInt64>

Specifies the minimum file size to include in the large file report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLargeFilePattern<String>

Specifies a string of files to include in the large file report. You can use the wildcard characters * and ? in the string.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLeastAccessedFilePattern<String>

Specifies a string of files to include in the least frequently accessed report. You can use the wildcard characters * and ? in the string.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLeastAccessedMinimum<Int32>

Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxDuplicateGroup<Int32>

Specifies the maximum number of groups of duplicate files to include in the duplicate files report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFile<Int32>

Specifies the maximum number of files to include in a storage report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFileGroup<Int32>

Specifies the maximum number of file groups to include in a file group report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFileScreenEvent<Int32>

Specifies the maximum number of file screens events to include in a file screen audit report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFilesPerDuplicateGroup<Int32>

Specifies the maximum number of files in an individual duplicate group to include in a duplicate files report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFilesPerFileGroup<Int32>

Specifies the maximum number of files in any file group to include in a file group report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFilesPerOwner<Int32>

Specifies the maximum number of files for any owner to include in a files by owner report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxFilesPerPropertyValue<Int32>

Specifies the maximum number of files for each property value to include in a files by property report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxOwner<Int32>

Specifies the maximum number of owners to include in a files by owner report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxPropertyValue<Int32>

Specifies the maximum number of property values to include in a files by property report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLimitMaxQuota<Int32>

Specifies the maximum number of quotas to include in a quota usage report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLocationIncident<String>

Specifies a path to a folder where the server stores incident reports.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLocationOnDemand<String>

Specifies a path to a folder where the server stores on demand reports.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportLocationScheduled<String>

Specifies a path to a folder where the server stores scheduled reports.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportMostAccessedFilePattern<String>

Specifies a string of files to include in the most frequently accessed report. You can use the wildcard characters * and ? in the string.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportMostAccessedMaximum<Int32>

Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportNotificationLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportPropertyFilePattern<String>

Specifies a string of files to include in the file by property report. You can use the wildcard characters * and ? in the string.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportPropertyName<String>

Specifies the property name to report on for a file by property report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportQuotaMinimumUsage<Int32>

Specifies the minimum quota usage level to include in the quota usage report.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SmtpServer<String>

Specifies the fully qualified domain name (FQDN) or IP address of the SMTP server that FSRM uses to send email.

You can use the Send-FsrmTestEmail cmdlet to send an email messages to test the SMTP server that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Change the FSRM setting for administrator email address

This command specifies the address "john@contoso.com" for the recipient of email that the server sends to the administrator.


PS C:\> Set-FsrmSetting -AdminEmailAddress "john@contoso.com"

Example 2: Change the FSRM setting for command notification limit

This command specifies 80 as the minimum number of seconds between individual running events of a command-type notification.


PS C:\> Set-FsrmSetting -CommandNotificationLimit 80

Example 3: Change the FSRM setting for report classification format

This command specifies XML as the format of classification reports that the server generates.


PS C:\> Set-FsrmSetting -ReportClassificationFormat @('Xml')

Example 4: Change the FSRM setting for report classification log type

This command specifies ErrorsInSystemLog as the type of log that the File Classification Infrastructure generates during classification.


PS C:\> Set-FsrmSetting -ReportClassificationLog @('ErrorsInSystemLog')

Example 5: Change the FSRM settings for large file reports and quota usage reports

This command specifies the wildcard character (*) to indicate that the large file report includes any files that match the value set for the ReportLargeFileMinimum parameter. The command also specifies that 100 is the maximum number of quotas to include in a quota usage report.


PS C:\> Set-FsrmSetting -ReportLargeFilePattern '*' -ReportLimitMaxQuota 100

Example 6: Change the FSRM setting for the SMTP server and file by owner reports

This command specifies "10.121.24.132" as the IP address of the SMTP server that FSRM uses to send email. The command also specifies "*.XML" as the file pattern to match for the file by owner report.


PS C:\> Set-FsrmSetting -SmtpServer "10.121.24.132" -ReportFileOwnerFilePattern ‘*.xml’

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft