[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

NotificationRule

Model that represents a notification rule. vRealize Operations Manager has a rule engine that evaluates these rules against generated alerts. Actions such as sending Email, HTTP callback is done based on matching rules. NOTE: resourceFilter and resourceKindFilter fields are deprecated, instead please use resourceFilters and resourceKindFilters fields respectively.


Properties

string
name Required

Name of this rule


array of string
alertControlStates Optional

Set of Alert control states that the alert is expected to be in

Possible values are: OPENASSIGNEDSUSPENDEDSUPPRESSED


alertImpactFilters Optional

Filter for the rule to match Alerts that have a specific Impact (Health, Risk or Efficiency). One or more of the String values - “HEALTH”, “RISK”, “EFFICIENCY” - must be specified.


array of string
alertStatuses Optional

Set of Alert states that the alert is expected to be in

Possible values are: NEWACTIVEUPDATEDCANCELED


array of AlertTypeFilter
alertTypeFilters Optional

Filter for the rule to match Alerts which are of the specified Alert type & Alert Subtypes


string
collectorGroupId Optional

Filter for the rule to match Alerts triggered on resources belonging to given collector group


string
collectorUUId Optional

Filter for the rule to match Alerts triggered on resources belonging to given collector


array of string
criticalities Optional

Set of Alert criticalities that the alert is expected to be in

Possible values are: UNKNOWNNONEINFORMATIONWARNINGIMMEDIATECRITICALAUTO


string as uuid
id Optional

Identifier of this rule, automatically assigned by the system on create


array of Link
links Optional

Represents a HTTP ’link’ element. It is implicit that all the link tags support http ‘GET’ method.


alertDefinitionIdFilters Optional

Filter for the rule to match Alerts that got generated because of specific Alert Definitions


string
pluginId Optional

Identifier of the plugin for which this rule applies


array of NameValue
properties Optional

Properties associated with the given rule. This may include information such as the email addresses of receivers/etc…


resourceFilter Optional

(Deprecated) Filter for the rule to be matched based on the “Resource and its Children” for which the Alerts were generated. NOTE: this field will be ignored if resourceFilters is specified


array of ResourceFilter
resourceFilters Optional

Filters for the rule to be matched based on the “Resource and its Children” for which the Alerts were generated. This collection takes precedence over resourceFilter field.


resourceKindFilter Optional

Filter for the rule to be matched based on the Resource Kind for which the alert was generated


array of ResourceKindKey
resourceKindFilters Optional

Filter for the rule to be matched based on the Resource Kind for which the alert was generated


string
templateId Optional

Identifier of the template. NOTE: For deprecated plugin types this field will be ignored. For all other plugin types, default templates will be used if this value is not specified.

JSON Example

{
	"name": "string"
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Property Of

NotificationRules
Parameter To

Update Notification Plugin Rule
Create Notification Plugin Rule
Returned By

Update Notification Plugin Rule
Create Notification Plugin Rule
Get Notification Rule

Feedback

Was this page helpful?