|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcEmsSnmpHistory
NAME
Remove-NcEmsSnmpHistory
SYNOPSIS
Delete EMS SNMP history entries.
SYNTAX
Remove-NcEmsSnmpHistory [-Node] <String> [-SequenceNumber] <Int64> [-Control
ler <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-NcEmsSnmpHistory -Query <EmsSnmpHistoryInfo> [-ContinueOnFailure] [-M
axFailureCount <Int32>] [-Controller <NcController[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Delete EMS SNMP history entries.
PARAMETERS
-Node <String>
Node emitting the EMS message.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SequenceNumber <Int64>
The message sequence number.
Required? true
Position? 2
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 <EmsSnmpHistoryInfo>
A EmsSnmpHistoryInfo object with various fields set to indicate which EM
S mail history entries to delete. Other fields should remain set to nul
l. Use "Get-NcEmsSnmpHistory -Template" to get the initially empty EmsS
nmpHistoryInfo object.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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: ems
API: ems-snmp-history-destroy-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Remove-NcEmsSnmpHistory -Node fas3070cluster01-01 -SequenceNumber 2
Remove the EMS SNMP history entry with sequence number 2 from node fas3070cl
uster01-01.
-------------- Example 2 --------------
C:\PS>$q = Get-NcEmsSnmpHistory -Template
$q.MessageName = "app.log.info"
Remove-NcEmsSnmpHistory -Query $q
Remove all of the EMS SNMP history entries for the given message name.
SuccessCount : 2
FailureCount : 0
SuccessList : {DataONTAP.C.Types.Ems.EmsSnmpHistoryInfo, DataONTAP.C.Types.
Ems.EmsSnmpHistoryInfo}
FailureList : {}
RELATED LINKS
Get-NcEmsSnmpHistory
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|