Retrieve event filter rules
Retrieves the rules configured for a specified event filter to see how events are matched and managed. Use this information to customize alert conditions and streamline event monitoring for your operational needs.
HTTP method and endpoint
GET /support/ems/filters/{name}/rules
Introduced in
ONTAP 9.6
Usage notes
Retrieves event filter rules.
Related ONTAP commands
-
event filter show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name |
string |
path |
True |
Filter Name |
index |
integer |
query |
False |
Filter by index |
message_criteria.snmp_trap_types |
string |
query |
False |
Filter by message_criteria.snmp_trap_types |
message_criteria.severities |
string |
query |
False |
Filter by message_criteria.severities |
message_criteria.name_pattern |
string |
query |
False |
Filter by message_criteria.name_pattern |
parameter_criteria.name_pattern |
string |
query |
False |
Filter by parameter_criteria.name_pattern
|
parameter_criteria.value_pattern |
string |
query |
False |
Filter by parameter_criteria.value_pattern
|
type |
string |
query |
False |
Filter by type |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[records] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"index": 1,
"message_criteria": {
"_links": {
"related": {
"href": "/api/resourcelink"
}
},
"name_pattern": "wafl.*",
"severities": "emergency,alert,error",
"snmp_trap_types": "standard,built_in"
},
"parameter_criteria": [
{
"name_pattern": "vol",
"value_pattern": "cloud*"
}
],
"type": "include"
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
_links
| Name | Type | Description |
|---|---|---|
related |
message_criteria
Matching message definitions for the filter. A property must be specified.
| Name | Type | Description |
|---|---|---|
_links |
||
name_pattern |
string |
Message name filter on which to match. Supports wildcards. Defaults to * if not specified. |
severities |
string |
A comma-separated list of severities or a wildcard. |
snmp_trap_types |
string |
A comma separated list of snmp_trap_types or a wildcard. |
parameter_criteria
Criterion used for parameter based filtering
| Name | Type | Description |
|---|---|---|
name_pattern |
string |
Parameter name pattern. Wildcard character '*' is supported. |
value_pattern |
string |
Parameter value pattern. Wildcard character '*' is supported. |
records
Rule for an event filter
| Name | Type | Description |
|---|---|---|
_links |
||
index |
integer |
Rule index. Rules are evaluated in ascending order. If a rule's index order is not specified during creation, the rule is appended to the end of the list. |
message_criteria |
Matching message definitions for the filter. A property must be specified. |
|
parameter_criteria |
array[parameter_criteria] |
Parameter criteria used to match against events' parameters. Each parameter consists of a name and a value. When multiple parameter criteria are provided in a rule, all must match for the rule to be considered matched. A pattern can include one or more wildcard '*' characters. |
type |
string |
Rule type |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |