Skip to main content

Update an event destination

Contributors

PATCH /support/ems/destinations/{name}

Introduced In: 9.6

Updates an event destination.

  • filters.name - New list of filters that should direct to this destination. The existing list is discarded.

  • certificate - New certificate parameters when the destination type is rest api.

  • event notification destination modify

  • event notification modify

Parameters

Name Type In Required Description

name

string

path

True

Destination name

Request Body

Name Type Description

_links

_links

access_control_role

access_control_role

Indicates the access control role that created the event destination and is used to control access to the destination based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.

certificate

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

  • Introduced in: 9.6

connectivity

connectivity

destination

string

Event destination

filters

array[filters]

name

string

Destination name. Valid in POST.

syslog

syslog

system_defined

boolean

Flag indicating system-defined destinations.

type

string

Type of destination. Valid in POST.

Example request
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_control_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ca": "VeriSign",
    "name": "string",
    "serial_number": 1234567890
  },
  "connectivity": {
    "errors": [
      {
        "message": {
          "arguments": [
            {
              "code": "string",
              "message": "string"
            }
          ],
          "code": "4",
          "message": "entry doesn't exist"
        },
        "node": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      }
    ],
    "state": "fail"
  },
  "destination": "administrator@mycompany.com",
  "filters": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "important-events"
    }
  ],
  "name": "Admin_Email",
  "syslog": {
    "format": {
      "hostname_override": "string",
      "message": "string",
      "timestamp_override": "string"
    },
    "port": 514,
    "transport": "string"
  },
  "system_defined": 1,
  "type": "email"
}

Response

Status: 200, Ok
Name Type Description

_links

_links

access_control_role

access_control_role

Indicates the access control role that created the event destination and is used to control access to the destination based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.

certificate

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

  • Introduced in: 9.6

connectivity

connectivity

destination

string

Event destination

filters

array[filters]

name

string

Destination name. Valid in POST.

syslog

syslog

system_defined

boolean

Flag indicating system-defined destinations.

type

string

Type of destination. Valid in POST.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_control_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ca": "VeriSign",
    "name": "string",
    "serial_number": 1234567890
  },
  "connectivity": {
    "errors": [
      {
        "message": {
          "arguments": [
            {
              "code": "string",
              "message": "string"
            }
          ],
          "code": "4",
          "message": "entry doesn't exist"
        },
        "node": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "node1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      }
    ],
    "state": "fail"
  },
  "destination": "administrator@mycompany.com",
  "filters": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "important-events"
    }
  ],
  "name": "Admin_Email",
  "syslog": {
    "format": {
      "hostname_override": "string",
      "message": "string",
      "timestamp_override": "string"
    },
    "port": 514,
    "transport": "string"
  },
  "system_defined": 1,
  "type": "email"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

983088

The destination name provided cannot be empty

983089

The destination name provided cannot contain spaces

983094

The destination name provided is invalid. The destination 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)

983104

The syslog destination provided is invalid

983107

A provided filter does not exist

983116

The number of notifications has reached maximum capacity

983117

The number of destinations has reached maximum capacity

983129

The rest-api destination must contain a valid scheme, such as http// or https//

983130

The rest-api destination provided contains an invalid URL

983131

The rest-api destination provided contains an invalid IPv6 URL

983142

The security certificate provided does not exist

983143

The private security key provided does not exist

983144

The security certificate information provided is incomplete. Provide the certificate and serial number

983145

The rest-api destination provided has an 'http://' scheme. It is invalid to provide certificate information

983150

The type of an existing destination cannot be changed

983152

Default destinations cannot be modified or removed

983184

A provided property cannot be configured on the requested destination type

983200

Access control role compatibility issue with provided filters

Also see the table of common errors in the Response body overview section of this documentation.

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 destination and is used to control access to the destination 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

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

Name Type Description

_links

_links

ca

string

Client certificate issuing CA

name

string

Certificate name

serial_number

string

Client certificate serial number

arguments

Name Type Description

code

string

Argument code

message

string

Message argument

message

Information to be displayed to the user.

Name Type Description

arguments

array[arguments]

Message arguments

code

string

Unique message code.

message

string

User message.

node

Name Type Description

_links

_links

name

string

uuid

string

errors

Error object included in the event of connectivity failure.

Name Type Description

message

message

Information to be displayed to the user.

node

node

connectivity

Name Type Description

errors

array[errors]

A list of errors encountered during connectivity checks.

state

string

Current connectivity state.

filters

Name Type Description

_links

_links

name

string

format

Name Type Description

hostname_override

string

Syslog Hostname Format Override. The supported hostname formats are no_override (hostname format based on the syslog.format.message property i.e. fqdn if syslog.format.message is rfc_5424, hostname_only if syslog.format.message is legacy_netapp), fqdn (Fully Qualified Domain Name) and hostname_only.

message

string

Syslog Message Format. The supported message formats are legacy_netapp (format: <PRIVAL>TIMESTAMP [HOSTNAME:Event-name:Event-severity]: MSG) and rfc_5424 (format: <PRIVAL>VERSION TIMESTAMP HOSTNAME Event-source - Event-name - MSG).

timestamp_override

string

Syslog Timestamp Format Override. The supported timestamp formats are no_override (timestamp format based on the syslog.format.message property i.e. rfc_3164 if syslog.format.message is legacy_netapp, iso_8601_local_time if syslog.format.message is rfc_5424), rfc_3164 (format: Mmm dd hh:mm:ss), iso_8601_local_time (format: YYYY-MM-DDThh:mm:ss+/-hh:mm) and iso_8601_utc (format: YYYY-MM-DDThh:mm:ssZ).

syslog

Name Type Description

format

format

port

integer

Syslog Port.

transport

string

Syslog Transport Protocol.

ems_destination

Name Type Description

_links

_links

access_control_role

access_control_role

Indicates the access control role that created the event destination and is used to control access to the destination based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.

certificate

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

  • Introduced in: 9.6

connectivity

connectivity

destination

string

Event destination

filters

array[filters]

name

string

Destination name. Valid in POST.

syslog

syslog

system_defined

boolean

Flag indicating system-defined destinations.

type

string

Type of destination. Valid in POST.

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.