Set-VBRVSAEventForwardingFilteringRule

Short Description

Returns an updated copy of an advanced filtering rule for Veeam Software Appliance syslog event forwarding.

Applies to

Product Edition: Veeam Universal License

Syntax

Set-VBRVSAEventForwardingFilteringRule -FilteringRule <VBRVSAEventForwardingFilteringRule> [-Application <String>] [-SeverityRules <VBRSyslogServerEventSeverity[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns a new VBRVSAEventForwardingFilteringRule object based on an existing rule, with the values you specify overriding the original application name and the array of forwarded severity levels.

Note

This cmdlet does not save changes to the configuration database. To apply the updated rule, pass the returned object to the Set-VBRVSAEventForwardingOptions cmdlet with the AdvancedFilters parameter.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
FilteringRule	Specifies the existing filtering rule that the cmdlet uses as the base for the updated copy.	Accepts the VBRVSAEventForwardingFilteringRule object. To create this object, run the New-VBRVSAEventForwardingFilteringRule cmdlet, or retrieve one from the AdvancedFilters property of Get-VBRVSAEventForwardingOptions.	True	Named	False
Application	Specifies the name of the application or daemon to which the rule applies.	String	False	Named	False
SeverityRules	Specifies an array of severity levels that the appliance will forward for the application. Accepted values: Emergency Alert Critical Error Warning Notice Informational Debug	VBRSyslogServerEventSeverity[]	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRVSAEventForwardingFilteringRule

Examples

Example 1. Modifying Severity Levels for Filtering Rule

This example shows how to build a copy of an existing filtering rule with new severity levels, and apply the updated rule to the appliance.

$options = Get-VBRVSAEventForwardingOptions

$rule = $options.AdvancedFilters[0]

$updatedRule = Set-VBRVSAEventForwardingFilteringRule -FilteringRule $rule -SeverityRules Emergency, Alert, Critical

Set-VBRVSAEventForwardingOptions -AdvancedFilters @($updatedRule)

Perform the following steps:

Run the Get-VBRVSAEventForwardingOptions cmdlet. Save the result to the $options variable.
Get the first filtering rule from the AdvancedFilters property of the $options variable. Save the result to the $rule variable.
Run the Set-VBRVSAEventForwardingFilteringRule cmdlet to build the updated rule. Save the result to the $updatedRule variable. Specify the following settings:

Set the $rule variable as the FilteringRule parameter value.
Set Emergency, Alert and Critical as the SeverityRules parameter value.

Run the Set-VBRVSAEventForwardingOptions cmdlet to persist the change. Pass the $updatedRule variable wrapped in an array as the AdvancedFilters parameter value.

Example 2. Renaming Application for Filtering Rule

This example shows how to build a copy of an existing filtering rule with a different application name, and apply the updated rule to the appliance.

$options = Get-VBRVSAEventForwardingOptions

$rule = $options.AdvancedFilters[0]

$updatedRule = Set-VBRVSAEventForwardingFilteringRule -FilteringRule $rule -Application "sshd"

Set-VBRVSAEventForwardingOptions -AdvancedFilters @($updatedRule)

Perform the following steps:

Run the Get-VBRVSAEventForwardingOptions cmdlet. Save the result to the $options variable.
Get the first filtering rule from the AdvancedFilters property of the $options variable. Save the result to the $rule variable.
Run the Set-VBRVSAEventForwardingFilteringRule cmdlet to build the updated rule. Set the $rule variable as the FilteringRule parameter value. Specify sshd as the Application parameter value. Save the result to the $updatedRule variable.
Run the Set-VBRVSAEventForwardingOptions cmdlet to persist the change. Pass the $updatedRule variable wrapped in an array as the AdvancedFilters parameter value.

Related Commands