|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcQosWorkload
NAME
Remove-NcQosWorkload
SYNOPSIS
Remove a workload.
SYNTAX
Remove-NcQosWorkload [-Name] <String> [-Controller <NcController[]>] [<Commo
nParameters>]
Remove-NcQosWorkload -Query <QosWorkloadInfo> [-ContinueOnFailure] [-MaxFail
ureCount <Int32>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Remove a workload. This also deletes any streams attached to the workload.
Only user defined workloads may be deleted.
PARAMETERS
-Name <String>
Name or universally unique identifier for the workload to which the stre
am is attached.
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 <QosWorkloadInfo>
A QosWorkloadInfo object with various fields set to indicate which QoS w
orkloads to delete. Other fields should remain set to null. Use "Get-N
cQosWorkload -Template" to get the initially empty QosWorkloadInfo objec
t.
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-workload-destroy, qos-workload-destroy-iter,qos-workload-delete
, qos-workload-delete-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Remove-NcQosWorkload -WorkloadUuid 9c4c3de2-6e0d-11e1-a794-12347856341
2
Remove the given workload.
-------------- Example 2 --------------
C:\PS>$q = Get-NcQosWorkload -Template
$q.WorkloadName = "test-workload"
Remove-NcQosWorkload -Query $q
Remove the workloads that match the given query.
SuccessCount : 1
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Qos.QosWorkloadInfo}
FailureList : {}
RELATED LINKS
Get-NcQosWorkload
New-NcQosWorkload
Set-NcQosWorkload
Update-NcQosWorkload
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|