notification-rule

notification-rule
notification-rule

Model that represents a notification rule.
VMware Cloud Foundation Operations 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.

JSON Example
{
    "id": "string",
    "name": "string",
    "pluginId": "string",
    "enabled": false,
    "templateId": "string",
    "alertControlStates": [
        "string"
    ],
    "alertStatuses": [
        "string"
    ],
    "criticalities": [
        "string"
    ],
    "resourceKindFilter": {
        "resourceKind": "string",
        "adapterKind": "string"
    },
    "resourceKindFilters": [
        {
            "resourceKind": "string",
            "adapterKind": "string"
        }
    ],
    "resourceFilter": {
        "resourceId": "string",
        "matchResourceIdOnly": false,
        "childrenResourceKindFilters": [
            "string"
        ],
        "childrenResourceKindKeyFilters": [
            {
                "resourceKind": "string",
                "adapterKind": "string"
            }
        ],
        "relationship": "string"
    },
    "resourceFilters": [
        {
            "resourceId": "string",
            "matchResourceIdOnly": false,
            "childrenResourceKindFilters": [
                "string"
            ],
            "childrenResourceKindKeyFilters": [
                {
                    "resourceKind": "string",
                    "adapterKind": "string"
                }
            ],
            "relationship": "string"
        }
    ],
    "alertTypeFilters": [
        {
            "alertType": 0,
            "alertSubTypes": [
                0
            ]
        }
    ],
    "alertDefinitionIdFilters": {
        "values": [
            "string"
        ]
    },
    "alertImpactFilters": {
        "values": [
            "string"
        ]
    },
    "sendHeartbeat": false,
    "properties": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "collectorUUId": "string",
    "collectorGroupId": "string",
    "ruleType": "string",
    "actionStatuses": [
        "string"
    ],
    "links": [
        {
            "href": "string",
            "rel": "string",
            "name": "string",
            "description": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

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

string
name
Required

Name of this rule

string
pluginId
Required

Identifier of the plugin for which this rule applies

boolean
enabled
Optional
Constraints: default: true

Identifier that shows if the notification rule is enabled. Enabled by default

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.

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,
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 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,
ResourceKindFilter
resourceKindFilter
Optional

Filter based on the resource kind

array of resource-kind-key
resourceKindFilters
Optional

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

ResourceFilter
resourceFilter
Optional

Filter for resources. If matchResourceIdOnly is specified, alerts are selected if their resource ids
match with the 'resourceId' specified in the filter. Otherwise, the system looks at all the resource's children.
The possible set of children can be further filtered based on the childrenResourceKindKeyFilters.

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.

array of AlertTypeFilter
alertTypeFilters
Optional

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

str-values
alertDefinitionIdFilters
Optional

alertDefinitionIdFilters

str-values
alertImpactFilters
Optional

alertImpactFilters

boolean
sendHeartbeat
Optional

Filter for the rule to send Alerts while they are active. Defaulted to False if nothing is provided.

array of name-value
properties
Optional

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

string
collectorUUId
Optional

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

string
collectorGroupId
Optional

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

string
ruleType
Optional

Notification Rule Type

Possible values are : ALERT, ACTION, UNKNOWN,
array of string
actionStatuses
Optional

Set of Action statuses that the action is expected to be in

Possible values are : SUCCEEDED, FAILED, TIMEOUT, UNKNOWN,
array of link
links
Optional

links

Property Of
Parameter To
Returned By