Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcQosPolicyReadAhead


NAME
Remove-NcQosPolicyReadAhead

SYNOPSIS
Remove a read-ahead policy.

SYNTAX
Remove-NcQosPolicyReadAhead [-Name] <String> [-Controller <NcController[]>]
[-WhatIf] [-Confirm] [<CommonParameters>]

Remove-NcQosPolicyReadAhead -Query <QosPolicyReadAheadInfo> [-ContinueOnFail
ure] [-MaxFailureCount <Int32>] [-Controller <NcController[]>] [-WhatIf] [-C
onfirm] [<CommonParameters>]


DESCRIPTION
Remove a read-ahead policy. The default policy may not be deleted. The poli
cy may not be attached to any workloads. Only user defined policies may be
deleted.


PARAMETERS
-Name <String>
Name of QoS read ahead 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

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <QosPolicyReadAheadInfo>
A QosPolicyReadAheadInfo object with various fields set to indicate whic
h QoS read ahead policies to delete. Other fields should remain set to
null. Use "Get-NcQosPolicyReadAhead -Template" to get the initially emp
ty QosPolicyReadAheadInfo 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-read-ahead-destroy, qos-policy-read-ahead-destroy-iter
Family: cluster

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

C:\PS>Remove-NcQosPolicyReadAhead test-policy


Remove the read ahead policy named "test-policy"





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

C:\PS>$q = Get-NcQosPolicyReadAhead -Template
$q.ReadAheadClass = "user_defined"
Remove-NcQosPolicyReadAhead -Query $q


Remove all user defined read ahead policies.


SuccessCount : 1
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Qos.QosPolicyReadAheadInfo}
FailureList : {}



RELATED LINKS
Get-NcQosPolicyReadAhead
New-NcQosPolicyReadAhead
Set-NcQosPolicyReadAhead
Update-NcQosPolicyReadAhead







 Data ONTAP® PowerShell Toolkit