PowerCLI Reference



This cmdlet creates an SPBM rule set.


New-SpbmRuleSet [-AllOfRules] <SpbmRule[]> [-Name <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet creates an SPBM rule set. An SpbmRuleSet object consists of multiple SpbmRule objects. It contains both capability-based and tag-based rules. Each of the capability-based rules must be of the same namespace.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AllOfRulesSpbmRule[]Specifies an array of SPBM rule objects for the new rule set.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
NameStringSpecifies a name for the new rule set.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The newly created SpbmRuleSet object


Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html


-------------------------- Example 1 --------------------------

New-SpbmRuleSet -AllOfRules (New-SpbmRule -AnyOfTags $tag1, $tag2)

Creates an SPBM rule set with a rule of tag objects $tag1, $tag2.

-------------------------- Example 2 --------------------------

New-SpbmRuleSet -AllOfRules $rule1, $rule2, $rule3

Creates an SPBM rule set with rule objects $rule1, $rule2, and $rule3.

Copyright © VMware, Inc. All rights reserved.