event_handler.exe: 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 (Windows 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:

event_handler.exe --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. 

Location

%plesk_cli%

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

Example

The following command creates the event handler for the "IP address created" action that triggers the email_ip.bat script if an IP address is added. The handler priority is set to 50.

event_handler.exe --create -command email_ip.bat -priority 50 -user psaadm -event 5

Commands
Command Parameter Description Example

--create or -c

 

Creates an event handler.

Requires -command , -priority , -user , and -event options.

To create the event handler send_ip (with priority 50) that triggers the email_ip.bat script if an IP address is added:

event_handler.exe --create -command email_ip.bat -priority 50 -user psaadm -event 5

or

event_handler.exe -c -command email_ip.bat -priority 50 -user psaadm -event 5

--update or -u

<handler_id>

Updates event handler settings.

Requires -user option.

To change the priority of event handler with ID 1 :

event_handler.exe --update 1 -user jdoe -priority 12

or

event_handler.exe -u 1 -user jdoe -priority 12

--delete or -d

<handler_id>

Removes an event handler.

To remove the event handler with ID 1:

event_handler.exe --delete 1

or

event_handler.exe -d 1

--list or -l

 

Provides information about existing handlers and their settings.

To list event handlers:

event_handler.exe --list

or

event_handler.exe -l

--list-events or -le

 

Lists events that can trigger event handlers. Each record includes event ID and description.

To view the available events:

event_handler.exe --list-events

or

event_handler.exe -le

--list-users or -lu

 

Lists users on behalf of which scripts defined in event handler settings (-command option) are executed.

To list users:

event_handler.exe --list-users

or

event_handler.exe -lu

--help or -h

 

Displays help on the utility use.

To view help on the use of this utility:

event_handler.exe --help

or

event_handler.exe -h

 

Options

Note: These options are used with --update and --create operations only.

Option Parameter Description Example

-user

<string>

Specifies the login name of a Plesk user on behalf of which scripts/files defined in event handler settings are executed.

Note: Login name of Plesk Administrator is "Plesk Administrator".

To run scripts of the event handler with ID 1 on behalf of John:

event_handler.exe --update 1 -user John

-priority

<number>

Value that determines the importance of an event handler relative to other event handlers. Lowest priority - 0. Highest priority - 100.

To set the priority of the handler with ID 1 and user jdoe to 75:

event_handler.exe --update 1 -user jdoe -priority 75

-command

<string>

Specifies one of the following:

  • Script code
  • Full name of the file which stores the code
  • Full name of an executable file

This code/file is executed on triggering a particular event handler.

Use "\" symbol to escape quotes within commands.

To update the event handler command:

event_handler.exe --update 1 -user jdoe -command ipconfig.exe

-event

<number>

Defines ID of the event that triggers a particular event handler. Use -le operation to find the required ID.

To set the event ID of the event handler (with ID 2) to 17:

event_handler.exe --update 2 -event 17 -user root

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.