## PowerCLI Reference

# Set-SpbmStoragePolicy

## Synopsis

This cmdlet overrides the current name, description, and rule sets of an existing storage policy in an SPBM server.

Syntax

Set-SpbmStoragePolicy -StoragePolicy <SpbmStoragePolicy[]> [-Name <String>] [-Description <String>] [-AnyOfRuleSets <SpbmRuleSet[]>] [-CommonRule <SpbmRule[]>] [-Server <VIServer>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Export-SpbmStoragePolicy
Get-SpbmStoragePolicy
Import-SpbmStoragePolicy
New-SpbmStoragePolicy
Remove-SpbmStoragePolicy

Detailed Description

This cmdlet overrides the current name, description, and rule sets of an existing storage policy in an SPBM server.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
AnyOfRuleSets | SpbmRuleSet[] | Specifies an array to overwrite the current rule sets in the policy. The SPBM rule sets should not contain SPBM rules from the VAIOFilter namespace. | false | false
CommonRule | SpbmRule[] | Specifies the SPBM rules from the VAIOFilter namespace only. These rules are considered with all the SPBM rule sets as common requirements. | false | false
Confirm | SwitchParameter | If 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. | false | false
Description | String | Specifies a new description for the storage policy. | false | false
Name | String | Specifies a new name for the storage policy. The maximum length of the name is 80 characters. | false | false
Server | VIServer | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | false
StoragePolicy | SpbmStoragePolicy[] | Specifies the storage policy to modify. | true | true (ByValue)
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false

Return Type

The modified SpbmStoragePolicy object

Notes

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

Examples

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

    Set-SpbmStoragePolicy -StoragePolicy $policy -Name "NewName" -Description NewDescription

Modifies the name and description of the $policy policy object.

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

    Set-SpbmStoragePolicy -StoragePolicy $policy -AnyOfRuleSets $ruleset1, $ruleset2

Updates the $policy policy object with the $ruleset1 and $ruleset2 rule set objects which overwrite the existing rule sets in the policy.

-------------- Example 3 --------------

    $p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule $cr

Modifies a storage policy to add a VAIOFilter rule.

-------------- Example 4 --------------

    $p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule @()

Modifies a storage policy to remove all VAIOFilter rules.

-------------- Example 5 --------------

    $p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule @($cr1, $cr2)

Modifies a storage policy to add a VAIOFilter rule $cr2 to an existing VAIOFilter rule $cr1.

Copyright © VMware, Inc. All rights reserved.