Definition File Format for UNIX

The format of the definition load file for events and event handlers follows the keyword / value-pair convention used for Universal Agent configuration files. However, because more than one definition can be specified in a load file, some additional conventions are used.

The begin_event and end_event keywords are used to mark the beginning and end, respectively, of each event definition entry.
The begin_handler and end_handler keywords are used to mark the beginning and end, respectively, of each event handler entry.
The begin_script and end_script keywords are used to mark the beginning and end, respectively, of any user script contained in the definition load file.

Lines that belong to the script must begin with the stmt keyword. Long stmt values that have to be split across lines can be done so using the + and - line continuation characters (as described in Configuration File Syntax). These lines will be accepted verbatim, and no script syntax validation will be done. Lines will continue to be added to the script until an end_script, end_handler, begin_handler, or begin_event keyword is read, or the end of the file is reached.

If a parameter's value contains spaces, it must be enclosed in single ( ' ) or double ( " ) quotation marks.

If quotes are to be saved as part of the parameter's value, enclose the value in single ( ' ) quotation marks quotes, and use a set of double ( " ) quotation marks to enclose the quoted value (for example, optname 'optval1 "optval2 optval2a" optval3').

The script keyword can be used in lieu of a begin_script/end_script block, in which case the contents of the specified file will be written to the event handler.

A sample definition file for UNIX is shown in the following figure.

# Indented lines are for illustration only.  Leading spaces are
# ignored by UEMLoad.  Defaults will be used for any omitted 
# values.

# Start of parameters for an event definition with an ID of
# "unix_event_sample".  

begin_event
   event_id unix_event_sample
   event_type FILE
   comp_name uems
   state enable
   inact_date_time 2011.12.31,23:59
   triggered_id unix_script_sample
   filespec 'uem*.dat'
   rename_file yes
   rename_filespec '$(compname).$(compid).$(date).$(seqno)'
end_event

# End of parameters for event definition "unix_event_sample".

# Start of parameters for an event handler with an ID of 
# "unix_script_sample".

begin_handler
   handler_id unix_script_sample
   handler_type SCRIPT
   maxrc 0
   userid uemuser
   begin_script
      stmt "#!/bin/sh"
      stmt ""
      stmt 'ls -al "/home/uem user"'
   end_script
   script_type bat
end_handler

# End of parameters for event handler "unix_script_sample".

# Start of parameters for an event definition with an ID of
# "unix_cmd_sample".

begin_handler
   handler_id unix_cmd_sample
   maxrc 0
   userid uemuser
   cmd 'homeuem usersomeapp'
end_handler

# End of parameters for event definition "unix_cmd_sample".

Definition File Options

The Definition File options used in this example are:

Option	Description
event_id	Identifier that uniquely identifies an event definition record.
event_type	Type of system event represented by the event definition record.
comp_name	Event-driven UEM Server responsible for monitoring the event.
state	Event definitions that should be processed or ignored by UEM.
inact_date_time	Date and time at which UEM will stop monitoring an event definition.
triggered_id	ID of an event handler record that UEM will execute when an event occurrence is triggered.
filespec	Name of a file to monitor.
rename_file	Specification for whether or not UEM should rename a monitored file when an event occurrence is triggered.
rename_filespec	Specification for how a file should be renamed when an event occurrence is triggered.
handler_id	Identifier that uniquely identifies an event handler record.
handler_type	Type of process executed for the event handler, based on the contents of the USER_COMMAND and USER_SCRIPT parameters.
maxrc	Highest value with which a handler can exit to still be considered as having executed successfully.
userid	ID of a user account in whose security context the handler process will be executed.
script_type	Type of script statements contained in the action field of the event handler record.
cmd	Command to execute on behalf of the event handler.

Components

UEMLoad Utility for UNIX

Definition File Format - UNIX

Definition File Format for UNIX

Definition File Options

Components