Edit

Share via


New-StorageQosPolicy

Creates a Storage QoS policy.

Syntax

Arguments (Default)

New-StorageQosPolicy
    [[-PolicyId] <Guid>]
    [[-Name] <String>]
    [[-MaximumIops] <UInt64>]
    [[-MinimumIops] <UInt64>]
    [[-MaximumIOBandwidth] <UInt64>]
    [[-ParentPolicy] <CimInstance>]
    [[-PolicyType] <PolicyType>]
    [-AsJob]
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Object

New-StorageQosPolicy
    [-Policy] <CimInstance>
    [-AsJob]
    [-CimSession <CimSession>]
    [-ThrottleLimit <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-StorageQoSPolicy cmdlet creates a Storage Quality of Service (Storage QoS) policy that specifies the maximum and minimum throughput.

This cmdlet generates the ID of the policy that it creates, if the PolicyId parameter is not specified.

For more information about Storage QoS, see Storage Quality of Servicehttps://technet.microsoft.com/en-us/library/Mt126108 (https://technet.microsoft.com/en-us/library/Mt126108).

Examples

Example 1: Create a policy

PS C:\>New-StorageQosPolicy -Name "Policy01" -MaximumIops 100 -MinimumIops 10

Name    MinimumIops MaximumIops Status

----    ----------- ----------- ------

Policy01 10          100         Ok

This command creates a policy with a maximum of 100 8KB-normalized IOPS and a minimum of 10.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:CimSession
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumIOBandwidth

Specifies the bandwidth limit for the policy, in bytes per seconds.

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumIops

Specifies the throughput limit for the policy, in units of 8KB-normalized Input/Output Operations Per Second (IOPS).

Storage usage is measured in normalized IOPS. This is a count of the storage input/output operations per second. Any IO that is 8KB or smaller is considered as one normalized IOPS. Any IO that is larger than 8KB is treated as multiple normalized IOPS. For example, a 256KB request is treated as 32 normalized IOPS.

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MinimumIops

Specifies the throughput reservation for the policy, in 8KB-normalized IOPS.

Parameter properties

Type:UInt64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the policy to create.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentPolicy

Specifies the parent policy of the policy that this cmdlet creates. The object must specify the PolicyId field.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Policy

Specifies the storage QoS Policy that this cmdlet creates in the policy manager. Must be a valid MSFT_StorageQoSPolicy instance that specifies MaximumIops and MinimumIops.

Parameter properties

Type:CimInstance
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Object
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PolicyId

Specifies the GUID of the policy that this cmdlet creates.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PolicyType

Specifies the type of the policy that this cmdlet creates. The acceptable values for this parameter are: Aggregated and Dedicated. In an aggregated policy, the maximum and minimum throughputs apply to the aggregate throughput of all initiators. In a dedicated policy, the minimum and maximum throughputs apply to each initiator individually.

Parameter properties

Type:PolicyType
Default value:None
Accepted values:Aggregated, Dedicated
Supports wildcards:False
DontShow:False

Parameter sets

Arguments
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ThrottleLimit

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

CimInstance

Outputs

Object