Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Get one or all email alert filter rules from the HPE OneView SMTP configuration.

​
Syntax

Get-OVSmtpAlertEmailFilter
    [-Name <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Get-OVSmtpAlertEmailFilter retrieves the email alert filter rules stored in the appliance’s SMTP configuration. Each filter rule defines:
  • A display name for the filter.
  • An optional OData/index query expression that selects which alerts match.
  • A list of recipient email addresses.
  • An optional scope query that restricts matching to specific resource scopes.
  • A disabled flag.
If Remote Support is enabled on the appliance, a synthetic Remote Support filter entry is also included in the results (read-only). Filter objects returned by this cmdlet can be passed to Set-OVSmtpAlertEmailFilter to modify them or to Remove-OVSmtpAlertEmailFilter to delete them.

​
Parameters

​
Name
String
Filter by the filter rule’s display name (filterName property). When omitted, all defined filters are returned.
​
ApplianceConnection
Object
Specify one or more appliance connection objects or names. Defaults to the default connection in $ConnectedSessions.

​
Examples

​
Get all email alert filters

Get-OVSmtpAlertEmailFilter

​
Get a specific filter by name

Get-OVSmtpAlertEmailFilter -Name 'Critical Infrastructure Alerts'

​
Check whether any filters are disabled

Get-OVSmtpAlertEmailFilter | Where-Object { $_.disabled } | Select-Object filterName, emails

​
Pipe a filter into Set-OVSmtpAlertEmailFilter to update recipients

$filter = Get-OVSmtpAlertEmailFilter -Name 'Critical Infrastructure Alerts'
Set-OVSmtpAlertEmailFilter -InputObject $filter -Emails 'newteam@corp.example.com','backup@corp.example.com'

​
Output

HPEOneView.Appliance.AlertEmailFilter Key properties:
PropertyTypeDescription
filterNameStringDisplay name of the filter rule
filterStringIndex query expression that selects matching alerts
emailsString[]List of recipient email addresses
scopeQueryStringScope restriction query
disabledBooleanWhether this filter is currently disabled
customEmailSenderEnabledBooleanWhether a custom sender address is used
customSenderEmailAddressStringCustom sender email address (if enabled)
ApplianceConnectionObjectAppliance the filter was retrieved from

Build docs developers (and LLMs) love

Get started for freeTalk to us