Skip to main content

Retrieve an event filter

Contributors

GET /support/ems/filters/{name}

Introduced In: 9.6

Retrieves an event filter.

  • event filter show

Parameters

Name Type In Required Description

name

string

path

True

Filter name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

access_control_role

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.

Example response
{
  "_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

returned_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

Name Type Description

self

href

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

_links

name

string

Role name

Name Type Description

related

href

message_criteria

Matching message definitions for the filter. A property must be specified.

Name Type Description

_links

_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

_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

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.