The notification adapter framework is comprised of five ASL scripts (rulesets) that control the operation of a notification adapter. Each notification adapter uses its own version of each ASL script. Each ASL script performs a specific function. The original versions of the ASL scripts are located in BASEDIR/smarts/rules/notifier/<adapter_name>, where <adapter_name> is the name of the notification adapter (for example, mail, file, trap, script, or tibrv).
Typically, it is unnecessary to edit the ASL scripts. This is reserved for more advanced adapter customizations. However, if you want to customize an adapter, retain the original (unedited) version of the ASL scripts. To modify an ASL script, use the sm_edit utility provided with your VMware Smart Assurance software. This will ensure that you modify a copy of the file and the copy is placed in the proper local subdirectory. “Editing notification adapter files” on page 20 contains additional information on modifying files and using sm_edit.
If you edit the file while the notifier is running, restart the notifier so that it rereads its framework script file:
-
Init <adapter_name>-init.asl
-
Sync <adapter_name>-sync.asl
-
Filter <adapter_name>-filter.asl
-
Notify <adapter_name>-notify.asl
-
Custom <adapter_name>-custom.asl
For example, the Log File Notifier Adapter's scripts are: file-init.asl, file-sync.asl, file-notify.asl, file-filter.asl, and file-custom.asl.
Notification adapters scripts contains descriptions for the ASL scripts associated with each of the notification adapters and indicates whether an ASL script is intended to be modified during the customization process.
ASL script filename |
To be modified |
Description |
---|---|---|
Init <adapter_name>-init.asl |
No |
Invoked when the adapter starts and shuts down. Adapter-specific initialization and preshutdown tasks are included in this script. |
Sync <adapter_name>-sync.asl |
No |
Invoked whenever the adapter connects or disconnects from a Domain Manager. This script is used for synchronization with the Domain Manager. |
Filter <adapter_name>-filter.asl |
Yes |
This ASL script is the first to run during normal event processing. Its purpose is twofold:
Within this script, add the “sentByCustom = TRUE” flag in order to execute customizations. |
Notify <adapter_name>-notify.asl |
No |
This ASL script is responsible for processing notifications and contains most of the processing directions. It performs the defined actions such as sending traps or emails. |
Custom <adapter_name>-custom.asl |
Yes |
This is the last ASL script invoked during normal event processing. Any customizations to be made belong in this ASL script. |
Appendix A, Customizing a Notification Adapter, contains additional information on customizing an adapter.