Retrieve event filters
Retrieves event filters to view the current configurations used for filtering system events. This helps in managing and understanding which events are captured based on the defined criteria.
HTTP method and endpoint
GET /support/ems/filters
Introduced in
ONTAP 9.6
Usage notes
Retrieves a collection of event filters.
Related ONTAP commands
-
event filter show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
rules.index |
integer |
query |
False |
Filter by rules.index |
rules.message_criteria.snmp_trap_types |
string |
query |
False |
Filter by rules.message_criteria.snmp_trap_types |
rules.message_criteria.severities |
string |
query |
False |
Filter by rules.message_criteria.severities |
rules.message_criteria.name_pattern |
string |
query |
False |
Filter by rules.message_criteria.name_pattern |
rules.parameter_criteria.name_pattern |
string |
query |
False |
Filter by rules.parameter_criteria.name_pattern
|
rules.parameter_criteria.value_pattern |
string |
query |
False |
Filter by rules.parameter_criteria.value_pattern
|
rules.type |
string |
query |
False |
Filter by rules.type |
name |
string |
query |
False |
Filter by name |
system_defined |
boolean |
query |
False |
Filter by system_defined
|
access_control_role.name |
string |
query |
False |
Filter by access_control_role.name
|
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"
}
},
"access_control_role": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "admin"
},
"name": "wafl-critical-events",
"rules": [
{
"_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"
}
],
"system_defined": 1
}
]
}
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 |
access_control_role
Indicates the access control role that created the event filter and is used to control access to the filter based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Role name |
_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. |
rules
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 |
records
| Name | Type | Description |
|---|---|---|
_links |
||
access_control_role |
Indicates the access control role that created the event filter and is used to control access to the filter based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset. |
|
name |
string |
Filter name |
rules |
array[rules] |
Array of event filter rules on which to match. |
system_defined |
boolean |
Flag indicating system-defined filters. |
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. |