Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcQosPolicyGroup


NAME
Remove-NcQosPolicyGroup

SYNOPSIS
Delete a QoS policy group.

SYNTAX
Remove-NcQosPolicyGroup [-Name] <String> [-Controller <NcController[]>] [<Co
mmonParameters>]

Remove-NcQosPolicyGroup -Query <QosPolicyGroupInfo> [-ContinueOnFailure] [-M
axFailureCount <Int32>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Delete a QoS policy group. The default policy group may not be deleted. The
policy group may not be attached to any workloads. Only user defined polic
y groups may be deleted.


PARAMETERS
-Name <String>
Name of the policy group. Policy group names must be unique and are rest
ricted to 128 alphanumeric characters, '-', and '_', and must start with
an alphanumeric character (a-z, A-Z, or 0-9).

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 <QosPolicyGroupInfo>
A QosPolicyGroupInfo object with various fields set to indicate which Qo
S policies to delete. Other fields should remain set to null. Use "Get
-NcQosPolicyGroup -Template" to get the initially empty QosPolicyGroupIn
fo 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-group-delete
Family: cluster

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

C:\PS>Remove-NcQosPolicyGroup -Name dummy_policy


Remove the given QoS policy group.





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

C:\PS>$q = Get-NcQosPolicyGroup -Template
$q.Vserver = 'dummy'
Remove-NcQosPolicyGroup -Query $q


Remove all of the QoS policy groups for vserver 'dummy'.


NcController : 10.63.165.62
SuccessCount : 2
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Qos.QosPolicyGroupInfo, DataONTAP.C.Types.
Qos.QosPolicyGroupInfo}
FailureList : {}



RELATED LINKS
Get-NcQosPolicyGroup
Set-NcQosPolicyGroup
New-NcQosPolicyGroup
Update-NcQosPolicyGroup







 Data ONTAP® PowerShell Toolkit