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

Update an event filter rule

PDFs

PATCH /support/ems/filters/{name}/rules/{index}

Updates an event filter rule.

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

  • event filter rule add

  • event filter rule delete

Learn more

Parameters

Name Type In Required Description

name

string

path

True

Filter name

index

string

path

True

Filter index

new_index

integer

query

False

New position for the filter rule index

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: 200, Ok

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

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

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.