Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

eventdefinition modify

  • Updated on Aug 14, 2026
  • Published on Aug 6, 2026
  • 2 minute(s) read
Prev Next

This command modifies an event definition. The event definition includes actions that can be triggered when an event occurs that matches the definition. These actions override the global actions that you can define for all events using eventdefinitionconfig modify.

Usage

eventdefinition modify --id ID
                      [--email-recipients RECIPIENTS]
                      [--webhooks IDs]
                      [--cooldown SECONDS]
                      [--raise-at-count COUNT]
                      [--severity CRITICAL|MAJOR|MINOR|INFO]
                      [--trigger-on TRIGGER_ON]
                      [--trigger-off TRIGGER_OFF]
                      [--time-frame TIMEFRAME]
                      [--enable-actions|--disable-actions]
                      [--enable|--disable]
                      [--enable-alarm-only|--disable-alarm-only]

Required Parameters

--id ID

Specifies the event definition to modify.

Options

--email-recipients RECIPIENTS

Configures email recipients to be notified on events and/or alarms of this definition.

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

--webhooks IDs

Attaches webhooks to the event definition.

​

Specify ​IDs​ as a comma-separated list of webhook IDs (can be obtained with the ​webhook list​​ command).

--cooldown SECONDS

Sets a minimum number of seconds to wait between two consecutive events.

--raise-at-count COUNT

Sets the number of event occurrences after which the alarm is raised.

--severity CRITICAL|MAJOR|MINOR|INFO

Changes the severity of events with this definition.

--trigger-on TRIGGER_ON

Sets the value at which an alarm is triggered on.

Relevant to the following event types: OBJECT_MODIFIED , THRESHOLD, RATE.

For OBJECT_MODIFIED type events, specify one or more valid values for the property in the definition of the event. Separate the values with a comma.

For example: --trigger-on FAILED,TIMEOUT

For THRESHOLD and RATE type events, specify an operator and a numeric value in the format: '<operator>', <value>

<operator> can be:

  • gt. Greater than

  • ge. Greater than or equal to

  • lt. Lower than

  • eq. Equal to

<value> is the numeric value.

For example: --trigger-on 'gt', 50

--trigger-off TRIGGER_OFF

Sets the value at which an alarm is triggered off.

Relevant to the following event types: OBJECT_MODIFIED and THRESHOLD.

Input format as for --trigger-on.

--time-frame TIMEFRAME

Sets the time frame for a RATE type event, in which an alarm is triggered if a property exceeds a threshold value within the configured time frame.

For example: --time-frame 12h

--disable-actions

Disables any configured email recipients and webhook for the event definition.

 --enable-actions

Reenables email recipients and webhook for the event definition, if disabled.

--disable

Disables the event definition, which stops events of the given definition being logged as events, or triggering call home, alarms or actions such as email, webhook or syslogs.

--enable

Re-enables a disabled event definition. See --disable.

--disable-alarm-only

If specified, email recipients and webhooks (if configured) are initiated by all events of this definition and not only by alarms. For example, if the object type is CNode, and the Property is state , then if --disable-alarm-only is specified, any change in state of a CNode will initiate the actions you configured for this event.

--enable-alarm-only

If specified, email recipients and webhooks (if configured) are initiated only by alarms and not by any and every event of this definition.

Example

This example attaches a webhook with webhook ID 2 to event definition 117:

vcli: admin> eventdefinition modify --id 117 --webhooks 2