Add-LXCAEventExclusionFilter

This cmdlet adds an event exclusion filter to exclude an event or active alert from a target device.

The Get-LXCAEvent cmdlet does not return excluded events. Use the Get-LXCAEventExclusionFilter cmdlet to get the exclusion filter. Use the Add-LXCAEventExclusionFilter and Remove-LXCAEventExclusionFilter cmdlets to add and remove the exclusion filter.

Note: You cannot pipe objects to this cmdlet.

Syntax

Add-LXCAEventExclusionFilter [-Connection LXCAConnection] 
                              -Name String 
                              -Description String
                              -SourceID String 
                              -Type String
                             [CommonParameter]

Parameters

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-Name String
Specifies the name of the exclusion filter. The name must be unique.
-Description String
Specifies a description for the exclusion filter.
-SourceID String
Specifies the UUID of the target device.
-Type String
Specifies the event type. You can specify one of the following event types:
  • event
  • activeAlert
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results

This cmdlet returns an EventExclusionFilter object.

Examples

The following example excludes all events from a device.

$cred = Get-Credential
Connect-LXCA -Host 192.0.2.0 -Credential $cred

Add-LXCAEventExclusionFilter -SourceID $node -Name "ExclusionFilterOnNode"  -Type event`
                             -Description "Suppress events from node"

Disconnect-LXCA

Related links