event_handler: Event Handlers

You can make Plesk run a particular action every time a certain event
occurs in Plesk. For example, you are able to save each added IP address
to a log file or perform other routine operations.

Plesk triggers actions relying on event handles - links between events
and actions. When an event happens, Plesk finds all event handlers
linked to this event and runs actions assigned to these handlers.

Event handlers management is available via the command line interface or
the Plesk GUI. For more information on creating event handlers via GUI,
see the section Adding Event Handlers (Linux Hosting) of the
Administrator’s Guide.

To manage event handlers via command line, use the event_handler
utility. This utility performs the following tasks:

• creating an event handler
• updating event handler settings
• listing all event handlers and their settings
• listing events that can trigger event handlers
• listing users on behalf of which scripts defined in event handler
  settings are executed
• removing event handlers

If you want to create an event handler for a particular event, you first
need to find out if Plesk supports handlers for this event. To do it,
execute the following command:

plesk bin event_handler --list-events

After you make sure that the event you need is present in the list,
define the following parameters: an action to perform, a user who
performs this action, and the action priority.

An action that Plesk will perform after the event occurs may be
specified in three ways:

• Run a snippet of code
• Run a specific script file.
• Run a binary file.

A user on behalf of which Plesk will execute the script must have enough
permissions to perform the action.

A priority is an integer number from 0 to 100 that defines the execution
sequence of event handlers assigned to a single event. The highest
priority handlers are executed first.

Usage

event_handler <command> [<handler_id>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

The following command creates the event handler…