Notification rule specifies the server to which this rule is applicable, certain conditions (i.e. triggers), and the action to be taken when the rule is hit. It also specifies where this rule engine is configured to be run.
References to notification:rule are object references.
The name part of a notification rule reference has the following components:
- The name of the notification rule
Example: notification:rule/ZG5zLm5ldHdvcmtfdmlldyQxMTk:rule1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): event_type, name, notification_action, notification_target.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| event_type | |
| expression_list | |
| name | |
| notification_action | |
| notification_target |
Determines whether the notification rule is applied on all members or not. When this is set to False, the notification rule is applied only on selected_members.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The notification rule descriptive comment.
Type
String.
Create
The default value is empty.
Search
The field is available for search via
Determines whether a notification rule is disabled or not. When this is set to False, the notification rule is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines whether the notification rule for event deduplication is enabled. Note that to enable event deduplication, you must set at least one deduplication field.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines whether the notification rule for the event deduplication syslog is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The list of fields that must be used in the notification rule for event deduplication.
Type
Enum values array.
Create
The default value is empty.
Search
The field is not available for search.
The lookback period for the notification rule for event deduplication.
Type
Unsigned integer.
Create
The default value is 600.
Search
The field is not available for search.
Event priority.
Type
String.
Create
The default value is NORMAL.
Search
The field is available for search via
The notification rule event type.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The event_type is part of the base object.
The notification rule expression list.
Type
A/An Notification rule expression operand struct array.
Create
The field is required on creation.
Search
The field is not available for search.
The notification rule name.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
The name cannot be updated.
The notification rule action is applied if expression list evaluates to True.
Type
String.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The notification_action is part of the base object.
The notification target.
Type
String.
This field supports nested return fields as described here.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The notification_target is part of the base object.
The publish settings.
Type
A/An Cisco ISE publish settings struct struct.
Create
The default value is empty.
Search
The field is not available for search.
Notes
publish_settings is associated with the field use_publish_settings (see use flag).
Schedule setting that must be specified if event_type is SCHEDULE.
Type
A/An Schedule Setting struct.
Create
The default value is empty.
Search
The field is not available for search.
The list of the members on which the notification rule is applied.
Type
String array.
Create
The default value is empty.
Search
The field is not available for search.
The notification REST template instance.
Type
A/An Notification REST template instance struct.
Create
The default value is empty.
Search
The field is not available for search.
Test notification rules by user created event.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
event_text ( String. ). This parameter is mandatory. The event to trigger notification rule in a JSON text string.
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| all_members | Bool | N | N | N | N/A |
| comment | String | N | N | N | : = ~ |
| disable | Bool | N | N | N | N/A |
| enable_event_deduplication | Bool | N | N | N | N/A |
| enable_event_deduplication_log | Bool | N | N | N | N/A |
| event_deduplication_fields | [Enum] | N | N | N | N/A |
| event_deduplication_lookback_period | Unsigned int | N | N | N | N/A |
| event_priority | String | N | N | N | : = ~ |
| event_type | String | Y | N | Y | = |
| expression_list | [struct] | Y | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| notification_action | String | Y | N | Y | = |
| notification_target | String | Y | N | Y | = |
| publish_settings | struct | N | N | N | N/A |
| scheduled_event | struct | N | N | N | N/A |
| selected_members | [String] | N | N | N | N/A |
| template_instance | struct | N | N | N | N/A |
| use_publish_settings | Bool | N | N | N | N/A |
notification:rest:template : The notification REST template object.
