Set-FsrmQuotaTemplate

Set-FsrmQuotaTemplate

Changes configuration settings for FSRM quota templates.

Syntax

Parameter Set: Query (cdxml)
Set-FsrmQuotaTemplate [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-PassThru] [-Size <UInt64> ] [-SoftLimit] [-Threshold <CimInstance[]> ] [-ThrottleLimit <Int32> ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-FsrmQuotaTemplate -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-PassThru] [-Size <UInt64> ] [-SoftLimit] [-Threshold <CimInstance[]> ] [-ThrottleLimit <Int32> ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-FsrmQuotaTemplate cmdlet changes configuration settings for one or more File Server Resource Manager (FSRM) quota templates.

When you make changes to a quota template, you have the option of extending those changes to existing quotas that are derived from the quota template. You can specify the UpdateDerivedMatching parameter to modify only those quotas that still match the original quota template, or you can specify the UpdateDerived parameter to modify all quotas that are derived from the quota template, regardless of any modifications that you made to the quotas since you created them.

Parameters

-AsJob

-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.

-Description<String>

Specifies a description for the quota.

-InputObject<CimInstance[]>

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

-Name<String[]>

Specifies an array of names of quota templates.

-PassThru

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

-Size<UInt64>

Specifies the size limit that the quota enforces.

-SoftLimit

Indicates that the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit.

-Threshold<CimInstance[]>

Specifies an array of threshold objects.

The threshold object defines a percentage of used space from the available space that can be reached during a file operation, and a set of actions that the server takes when a quota reaches the threshold. To perform the action when the quota is exceeded, set the threshold to 100 (percent). You can use the New-FsrmQuotaThreshold cmdlet to create a threshold object.

-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.

-UpdateDerived

Indicates that the server modifies all quotas that are derived from the quota template. If you specify this parameter, you cannot specify the UpdateDerivedMatching parameter.

-UpdateDerivedMatching

Indicates that the server updates only the quotas that are derived from the quota template that you have not modified since you created the quotas. Specify this parameter if you have quotas that have been modified since they were automatically generated, and you do not want to change them.

If you specify this parameter, you cannot specify the UpdateDerived parameter.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

• Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuotaTemplate

Examples

Example 1: Change the size limit of a quota template

This command changes the quota template named "1GB limit" to have a 1.5GB limit, and adds a description to the quota template.

PS C:\> Set-FsrmQuotaTemplate -Name "1GB limit" -Description “limit usage to 1.5 GB.” -Size 1.5GB

Example 2: Change the size limit of all quotas that are derived from a quota template

This command changes the quota template named "1GB limit" to have a 1.5GB limit. The UpdateDerived parameter indicates that this command updates all quotas on the server that are derived from the quota template to have a 1.5GB limit.

PS C:\> Set-FsrmQuotaTemplate "1GB limit" -Description "limit usage to 1.5 GB." -Size 1.5GB -UpdateDerived

Related topics

Get-FsrmQuotaTemplate

New-FsrmQuotaTemplate

Remove-FsrmQuotaTemplate

New-FsrmQuotaThreshold