PowerCLI Reference

Remove-SpbmStoragePolicy

Synopsis

This cmdlet deletes storage policies.

Syntax

Remove-SpbmStoragePolicy [-StoragePolicy] <SpbmStoragePolicy[]> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

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

Detailed Description

This cmdlet deletes storage policies.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
StoragePolicySpbmStoragePolicy[]Specifies the storage policies to be deleted.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
ServerVIServer[]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.falsetrue (ByValue)
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

None

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

Remove-SpbmStoragePolicy -StoragePolicy $policy1, $policy2

Deletes all storage policies represented by the $policy1 and $policy2 objects.

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

Remove-SpbmStoragePolicy -StoragePolicy policytest*

Deletes all storage policies whose name starts with "policytest".


Copyright © VMware, Inc. All rights reserved.