Share via

Set-SCStorageQoSPolicy

Module:
VirtualMachineManager Module

Modifies a storage QoS policy on one or more storage file servers.

Syntax

Default (Default) 

Set-SCStorageQoSPolicy
    [-StorageQoSPolicy] <StorageQoSPolicy>
    [-Name <String>]
    [-Description <String>]
    [-IOPSMaximum <UInt64>]
    [-IOPSMinimum <UInt64>]
    [-BandwidthLimitMBPS <UInt64>]
    [-AddStorageFileServer <StorageFileServer[]>]
    [-RemoveStorageFileServer <StorageFileServer[]>]
    [-AddStorageArray <StorageArray[]>]
    [-RemoveStorageArray <StorageArray[]>]
    [-RepairPolicy]
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Set-SCStorageQoSPolicy cmdlet modifies a storage Quality of Service (QoS) policy on one or more storage file servers.

Parameters

-AddStorageArray

The Set-SCStorageQoSPolicy cmdlet modifies a storage Quality of Service (QoS) policy on one or more storage file servers.

Parameter properties

Type:

StorageArray[]

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

-AddStorageFileServer

Specifies an array of storage file servers.

Parameter properties

Type:

StorageFileServer[]

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

-BandwidthLimitMBPS

The Set-SCStorageQoSPolicy cmdlet modifies a storage Quality of Service (QoS) policy on one or more storage file servers.

Parameter properties

Type:UInt64
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

-Description

Specifies a description for the QoS policy.

Parameter properties

Type:String
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

-IOPSMaximum

Specifies the maximum IOPS.

Parameter properties

Type:UInt64
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

-IOPSMinimum

Specifies the minimum IOPS.

Parameter properties

Type:UInt64
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

-JobVariable

Specifies a variable in which job progress is tracked and stored.

Parameter properties

Type:String
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

-Name

Specifies the name of a VMM object.

Parameter properties

Type:String
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

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Parameter properties

Type:Guid
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

-RemoveStorageArray

The Set-SCStorageQoSPolicy cmdlet modifies a storage Quality of Service (QoS) policy on one or more storage file servers.

Parameter properties

Type:

StorageArray[]

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

-RemoveStorageFileServer

Specifies an array of storage file servers.

Parameter properties

Type:

StorageFileServer[]

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

-RepairPolicy

Indicates that this operation repairs the specified policy.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-StorageQoSPolicy

Specifies a StorageQoSPolicy object.

Parameter properties

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

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
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.

Outputs

StorageQoSPolicy

This cmdlet returns a StorageQoSPolicy object.