Skip to main content
A newer release of this product is available.

Create an event filter

Contributors
PDFs

POST /support/ems/filters

Introduced In: 9.6

Creates an event filter.

Required properties

  • name - String that uniquely identifies the filter.

  • rules - List of criteria which is used to match a filter with an event.

  • event filter create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

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 request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_control_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "name": "snmp-traphost",
  "rules": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "index": 1,
      "message_criteria": {
        "_links": {
          "related": {
            "href": "/api/resourcelink"
          }
        },
        "name_pattern": "callhome.*",
        "severities": "error,informational",
        "snmp_trap_types": "standard|built_in"
      },
      "parameter_criteria": [
        {
          "name_pattern": "vol",
          "value_pattern": "cloud*"
        }
      ],
      "type": "include"
    }
  ],
  "system_defined": 1
}

Response

Status: 201, Created
Name Type Description

_links

_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": "snmp-traphost",
      "rules": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "index": 1,
          "message_criteria": {
            "_links": {
              "related": {
                "href": "/api/resourcelink"
              }
            },
            "name_pattern": "callhome.*",
            "severities": "error,informational",
            "snmp_trap_types": "standard|built_in"
          },
          "parameter_criteria": [
            {
              "name_pattern": "vol",
              "value_pattern": "cloud*"
            }
          ],
          "type": "include"
        }
      ],
      "system_defined": 1
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

983088

The filter name provided is empty

983089

The filter name provided cannot contain spaces

983092

The index of the rule provided is outside the allowed range for the filter provided

983094

The filter name provided is invalid. The filter name must contain between 2 and 64 characters and start and end with an alphanumeric symbol or (underscore). The allowed special characters are (underscore) and -(hyphen)

983095

The rule index provided is invalid for the filter provided

983101

No event is matched by the rule provided

983113

Default filters cannot be modified or removed

983114

The maximum number of filters is reached

983115

The maximum number of filter rules is reached

983126

A rule requires at least one name_pattern, severities, snmp_trap_types, or parameter pattern to be defined

983127

A property cannot contain a combination of the wildcard character and other values

983128

An invalid value is provided for the property 'snmp_trap_types'

983146

An invalid value is provided for the property 'severities'

983147

The severities provided are not supported

983155

The provided severities property does not match that of the name_pattern

983156

The provided snmp_trap_types property does not match that of the name_pattern

983157

The provided severities and snmp_trap_types properties do not match those of the name_pattern

983158

The name_pattern provided does not exist

983195

Empty field in parameter_criteria. Both name and value patterns must be specified

983196

name_pattern and value_pattern fields in parameter_criteria are empty

983211

Parameter criteria based filtering is not supported in this version of ONTAP
Name Type Description

error

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

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

_links

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

ems_filter

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.

_links

Name Type Description

next

href

self

href

records

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.