[{"label":"Latest (2022-10-31)","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: OPEN , ASSIGNED , SUSPENDED , SUPPRESSED

StrValues

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: NEW , ACTIVE , UPDATED , CANCELED

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: UNKNOWN , NONE , INFORMATION , WARNING , IMMEDIATE , CRITICAL , AUTO

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.

StrValues

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

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

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

Show optional properties

{
	"name": "string"
}

{
	"alertControlStates": [
		"OPEN"
	],
	"alertDefinitionIdFilters": {
		"values": [
			"string"
		]
	},
	"alertImpactFilters": {
		"values": [
			"string"
		]
	},
	"alertStatuses": [
		"NEW"
	],
	"alertTypeFilters": [
		{
			"alertSubTypes": [
				0
			],
			"alertType": 0
		}
	],
	"collectorGroupId": "string",
	"collectorUUId": "string",
	"criticalities": [
		"UNKNOWN"
	],
	"id": "string",
	"links": [
		{
			"description": "string",
			"href": "string",
			"name": "string",
			"rel": "NEXT"
		}
	],
	"name": "string",
	"pluginId": "string",
	"properties": [
		{
			"name": "string",
			"value": "string"
		}
	],
	"resourceFilter": {
		"childrenResourceKindFilters": [
			"string"
		],
		"childrenResourceKindKeyFilters": [
			{
				"adapterKind": "string",
				"resourceKind": "string"
			}
		],
		"matchResourceIdOnly": false,
		"relationship": "PARENT",
		"resourceId": "string"
	},
	"resourceFilters": [
		{
			"childrenResourceKindFilters": [
				"string"
			],
			"childrenResourceKindKeyFilters": [
				{
					"adapterKind": "string",
					"resourceKind": "string"
				}
			],
			"matchResourceIdOnly": false,
			"relationship": "PARENT",
			"resourceId": "string"
		}
	],
	"resourceKindFilter": {
		"adapterKind": "string",
		"resourceKind": "string"
	},
	"resourceKindFilters": [
		{
			"adapterKind": "string",
			"resourceKind": "string"
		}
	],
	"templateId": "string"
}

[{"label":"Latest (2022-10-31)","version":"latest"}]

vrealize-operations

Property Of

NotificationRules

Parameter To

Create Notification Plugin Rule
Update Notification Plugin Rule

Returned By

Update Notification Plugin Rule
Create Notification Plugin Rule
Get Notification Rule

NotificationRule

Properties

JSON Example

Property Of

Parameter To

Returned By

Was this page helpful?