eventdefinitionconfig modify

--smtp-host SMTP_HOST

Sets the host name of the SMTP server from which to send alarm notification emails.

Example: --smtp-host mail.company.com

--smtp-port SMTP_PORT

Sets the port used by the SMTP server to send outgoing emails.

--smtp-user SMTP_USER

Sets a user for SMTP host authentication.

--smtp-password SMTP_PASSWORD

Sets the password for the SMTP user.

--smtp-enable-tls

Enables sending alarm notification emails over a TLS connection.

--smtp-disable-tls

Disables TLS for sending alarm notification emails (default).

--email-subject SUBJECT

Optionally specifies a string that is used globally as the subject for all notification emails.

By default, alarm info appears in the subject.

Example: --email-subject VAST Alarm

--email-sender SENDER

Specifies the sender email that appears in alarm notification emails. It is global for all alarm notification emails.

Example: --email-sender do_not_reply@company.com

--email-recipients RECIPIENTS

Sets default email recipients. These recipients receive notifications of all alarms except those triggered by events that have a different list of email recipients specified in the event definition or for which actions are disabled.

Specify RECIPIENTS as a comma separated list of email addresses (no spaces).

Example: --email-recipients storage_admin@company.com,bsmith@company.com,abrown@company.com

--syslog-host SYSLOG_HOST

To send alarms to a syslog server, use this option to specify a remote syslog server's IP address.

For example: --syslog-host 192.0.2.0

--syslog-port PORT

Sets the syslog port number. Default: 514

--syslog-protocol udp|tcp

If --syslog-host is set, use this option to set which protocol to use to communicate with the syslog server.

Default: udp.

--webhook-url URL

Include this option to configure a webhook to be triggered by default by all types of events.

A webhook contacts an external application and invokes an HTTP method in the external application. This feature requires the external application to support webhooks.

This option specifies the webhook URL of the external application that you want to trigger. Obtain the webhook URL from the external application.

See also --webhook-method.

--webhook-method POST|GET|PUT|PATCH|DELETE

Include this option if you are configuring a webhook. See --webhook-url.

This option specifies which HTTP method to invoke when the webhook is triggered. If the method sends a payload, use --webhook-data to specify the payload.

--webhook-data PAYLOAD

Include this option to specify a payload to send if you are configuring a webhook. Relevant depending on the webhook method. See first --webhook-url and --webhook-method.

Specify the PAYLOAD in JSON format encapsulated with ''. Use the data structure supported by the external application. You can include the event message in a text string by specifying the $event variable.

For example: --webhook-data '"text":"$event"'

--disable-actions

Disables any configured email recipients, webhook and syslog server.

--enable-actions

Enables any configured email recipients, webhook and syslog server (default).

--quota-email-suffix

Specifies a suffix to append to user names to form an email address. This is used as the email recipient address for sending a user an email if they exceed a user quota limit. It is used if an email address is not found for the user on a provider.

--quota-email-provider CONTEXT

Specifies the query context to used when querying providers for user emails in order to send users notifications of exceeding user quotas.

Possible values:

--quota-email-interval

Specifies the minimal interval time between quota emails sent to a user.

Format: <days> <hours>:<minutes>:<seconds>

For example, if you specify 1 00:00:00, a user will not receive more than one email each day.

Example: --quota-email-interval '1 06:30:00'