|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcQosPolicy
NAME
Remove-NcQosPolicy
SYNOPSIS
Remove a policy.
SYNTAX
Remove-NcQosPolicy [-PolicyUuid] <String> [-Controller <NcController[]>] [<C
ommonParameters>]
Remove-NcQosPolicy -Query <QosPolicyInfo> [-ContinueOnFailure] [-MaxFailureC
ount <Int32>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Remove a policy. The policy may not be attached to any workloads. Only use
r defined policies may be deleted.
This cmdlet is not available for Data ONTAP 8.2 and up.
PARAMETERS
-PolicyUuid <String>
Universally unique identifier for the QoS policy.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Query <QosPolicyInfo>
A QosPolicyInfo object with various fields set to indicate which QoS pol
icies to delete. Other fields should remain set to null. Use "Get-NcQo
sPolicy -Template" to get the initially empty QosPolicyInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContinueOnFailure
This input element is useful when multiple objects match a given query.
If set to true, the API will continue removing the next matching object
even when removal of a previous object fails. If set to false, the API
will return on the first failure. Default: false.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxFailureCount <Int32>
When allowing failures, then this input element may be provided to limit
the number of failed remove operations before the server gives up and r
eturns. If set, the cmdlet will continue removing the next matching obj
ect even when the removal of a previous matching object fails, and do so
until the total number of objects failed to be removed reaches the maxi
mum specified. If set to the maximum or not provided, then there will b
e no limit on the number of failed remove operations. Only applicable i
f ContinueOnFailure is specified. Default: 2^32-1
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
NOTES
Category: qos
API: qos-policy-destroy, qos-policy-destroy-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Remove-NcQosPolicy cd1030f0-6e01-11e1-a794-123478563412
Remove the specified Quality of Service policy.
-------------- Example 2 --------------
C:\PS>$q = Get-NcQosPolicy -Template
$q.PolicyClass = "user_defined"
Remove-NcQosPolicy -Query $q -Verbose
Removes all user defined quality of service policies.
SuccessCount : 2
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Qos.QosPolicyInfo, DataONTAP.C.Types.Qos.Q
osPolicyInfo}
FailureList :
RELATED LINKS
Get-NcQosPolicy
New-NcQosPolicy
Set-NcQosPolicy
Update-NcQosPolicy
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|