Export (0) Print
Expand All
Expand Minimize
1 out of 1 rated this helpful - Rate this topic

File Server Resource Manager (FSRM) Cmdlets in Windows PowerShell

Updated: December 6, 2012

Applies To: Windows Server 2012

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

File Server Resource Manager Cmdlets

This reference provides cmdlet descriptions and syntax for all File Server Resource Manager (FSRM) cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

 

Cmdlet Description

Get-FsrmAdrSetting

Gets access denied remediation settings for events.

Get-FsrmAutoQuota

Gets auto apply quotas on a server.

Get-FsrmClassification

Gets the status of the running file classification.

Get-FsrmClassificationPropertyDefinition

Gets definitions of classification properties.

Get-FsrmClassificationRule

Gets classification rules.

Get-FsrmEffectiveNamespace

Gets a list of paths that match static namespaces.

Get-FsrmFileGroup

Gets file groups.

Get-FsrmFileManagementJob

Gets file management jobs.

Get-FsrmFileScreen

Gets file screens.

Get-FsrmFileScreenException

Gets file screen exceptions.

Get-FsrmFileScreenTemplate

Gets file screen templates.

Get-FsrmMacro

Gets FSRM-supported macros.

Get-FsrmMgmtProperty

Gets management properties.

Get-FsrmQuota

Gets FSRM quotas on the server.

Get-FsrmQuotaTemplate

Gets FSRM quota templates

Get-FsrmRmsTemplate

Gets a list of all RMS templates on the server.

Get-FsrmSetting

Gets the current FSRM settings.

Get-FsrmStorageReport

Gets storage reports.

New-FsrmAction

Returns an FSRM action object.

New-FsrmAutoQuota

Creates an auto apply quota.

New-FsrmClassificationPropertyDefinition

Creates a classification property definition.

New-FsrmClassificationPropertyValue

Creates a classification property value.

New-FsrmClassificationRule

Creates an automatic classification rule.

New-FsrmFileGroup

Creates a file group.

New-FsrmFileManagementJob

Creates a file management job.

New-FsrmFileScreen

Creates a file screen.

New-FsrmFileScreenException

Creates a file screen exception.

New-FsrmFileScreenTemplate

Creates a file screen template.

New-FsrmFmjAction

Returns an action object for file management jobs.

New-FsrmFmjCondition

Creates a file management property condition object.

New-FsrmFMJNotification

Returns a notification object for file management jobs.

New-FsrmFmjNotificationAction

Returns a notification action object for file management jobs.

New-FsrmQuota

Creates a FSRM quota.

New-FsrmQuotaTemplate

Creates a quota template.

New-FsrmQuotaThreshold

Returns a quota threshold object.

New-FsrmScheduledTask

Creates a scheduled task object.

New-FsrmStorageReport

Creates a storage report on the server.

Remove-FsrmAutoQuota

Removes an auto apply quota from a server.

Remove-FsrmClassificationPropertyDefinition

Removes classification property definitions.

Remove-FsrmClassificationRule

Removes classification rules.

Remove-FsrmFileGroup

Removes file groups from the server.

Remove-FsrmFileManagementJob

Removes file management jobs.

Remove-FsrmFileScreen

Removes a file screen.

Remove-FsrmFileScreenException

Removes a file screen exception.

Remove-FsrmFileScreenTemplate

Removes file screen templates.

Remove-FsrmMgmtProperty

Removes a management property.

Remove-FsrmQuota

Removes a FSRM quota from the server.

Remove-FsrmQuotaTemplate

Removes FSRM quota templates.

Remove-FsrmStorageReport

Removes storage reports.

Reset-FsrmFileScreen

Resets the default settings for all file screen parameters.

Reset-FsrmQuota

Updates configuration settings of a FSRM quota.

Send-FsrmTestEmail

Sends a test email message.

Set-FsrmAdrSetting

Changes configuration settings for access denied remediation.

Set-FsrmAutoQuota

Changes configuration settings of an auto apply quota.

Set-FsrmClassification

Changes configuration settings for classification.

Set-FsrmClassificationPropertyDefinition

Changes a classification property definition.

Set-FsrmClassificationRule

Changes configuration settings of classification rules.

Set-FsrmFileGroup

Changes configuration settings for file groups.

Set-FsrmFileManagementJob

Changes configuration settings of a file management job.

Set-FsrmFileScreen

Changes configuration settings of a file screen.

Set-FsrmFileScreenException

Changes configuration settings of a file screen exception.

Set-FsrmFileScreenTemplate

Changes configuration settings of a file screen template.

Set-FsrmMgmtProperty

Changes the setting of a management property.

Set-FsrmQuota

Changes configuration settings for a FSRM quota.

Set-FsrmQuotaTemplate

Changes configuration settings for FSRM quota templates.

Set-FsrmSetting

Changes global FSRM settings for the computer.

Set-FsrmStorageReport

Changes settings of a storage report.

Start-FsrmClassification

Starts the classification process.

Start-FsrmFileManagementJob

Starts a file management job.

Start-FsrmStorageReport

Starts generating storage reports.

Stop-FsrmClassification

Stops the running instance of a classification.

Stop-FsrmFileManagementJob

Stops the running instance of a file management job.

Stop-FsrmStorageReport

Stops the running instance of storage reports.

Update-FsrmAutoQuota

Updates the properties of an auto apply quota.

Update-FsrmClassificationPropertyDefinition

Updates the classification property definitions.

Update-FsrmQuota

Starts a quota scan on a path.

Wait-FsrmClassification

Waits for a period of time or until classification is finished running.

Wait-FsrmFileManagementJob

Waits for file management jobs to finish running.

Wait-FsrmStorageReport

Waits for a period of time or until storage reports is finished running.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module FileServerResourceManager cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see the following:

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.