Skip to main content

Support EMS filters name endpoint overview

Contributors
PDFs

Overview

Manages a specific filter instance. See the documentation for /support/ems/filters for details on the various properties.

Examples

Retrieving a specific filter instance

# The API:
GET /api/support/ems/filters/{name}

# The call:
curl -X GET "https://<mgmt-ip>/api/support/ems/filters/aggregate-events" -H "accept: application/hal+json"

# The response:
200 OK

# JSON Body
{
"name": "aggregate-events",
"rules": [
  {
    "index": 1,
    "type": "include",
    "message_criteria": {
      "name_pattern": "*",
      "severities": "emergency,alert,error,notice",
      "snmp_trap_types": "*",
      "_links": {
        "related": {
          "href": "/api/support/ems/messages?name=*&severity=emergency,alert,error,notice&snmp_trap_type=*"
        }
      }
    },
    "parameter_criteria": [
      {
        "name_pattern": "type",
        "value_pattern": "aggregate"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/support/ems/filters/aggregate-events/rules/1"
      }
    }
  },
  {
    "index": 2,
    "type": "exclude",
    "message_criteria": {
      "name_pattern": "*",
      "severities": "*",
      "snmp_trap_types": "*",
      "_links": {
        "related": {
          "href": "/api/support/ems/messages?name=*&severity=*&snmp_trap_type=*"
        }
      }
    },
    "parameter_criteria": [
      {
        "name_pattern": "*",
        "value_pattern": "*"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/support/ems/filters/aggregate-events/rules/2"
      }
    }
  }
],
"_links": {
  "self": {
    "href": "/api/support/ems/filters/aggregate-events"
  }
}
}

Updating an existing filter with a new rule

# The API:
PATCH /api/support/ems/filters/{name}

# The call:
curl -X PATCH "https://<mgmt-ip>/api/support/ems/filters/test-filter" -H "accept: application/hal+json" -H "Content-Type: application/json" -d "@test_ems_filters_patch.txt"
test_ems_filters_patch.txt(body):
{
"rules": [
  {
    "type": "include",
    "message_criteria": {
      "name_pattern": "wafl.*",
      "severities": "error"
    }
  }
]
}

# The response:
200 OK

Deleting an existing filter

# The API:
DELETE /api/support/ems/filters/{name}

# The call:
curl -X DELETE "https://<mgmt-ip>/api/support/ems/filters/test-filter" -H "accept: application/hal+json"

# The response:
200 OK