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

Create an event filter rule

Contributors
PDFs

POST /support/ems/filters/{name}/rules

Introduced In: 9.6

Creates an event filter rule.

Required properties

  • message_criteria - Criteria on which a rule is to match an event.

  • index - One-based position index of the new rule.

  • event filter rule add

Parameters

Name Type In Required Description

name

string

path

True

Filter name

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

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.

type

string

Rule type
Example request 
{
  "_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"
  },
  "type": "include"
}

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": "3",
  "records": [
    {
      "_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"
      },
      "type": "include"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

983092

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

983095

The rule index provided is invalid for the filter provided

983113

Default filters cannot be modified or removed

983115

The maximum number of filter rules is reached

983126

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

983127

A property cannot contain a combination of the wildcard characters 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 severity levels 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 do not match those of the name_pattern

983158

The name_pattern provided does not exist
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

_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.

ems_filter_rule

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.

type

string

Rule type

_links

Name Type Description

next

href

self

href

records

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.

type

string

Rule type

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.