Halcyon PrimeAlert (R) ModuleScheduler
Version 1.0.0
For use with Sun Management Center
README
-----------------------------------------------------------------------
Included Components
===================
This distribution includes a single PrimeAlert module:
PrimeAlert ModuleScheduler
Nomenclature
============
- 'Sun Management Center' was formerly called 'Sun Enterprise SyMON'.
This product only supports Sun Management Center 2.1 or higher.
Supported Platforms
===================
The following table summarizes the platform support for the various
components contained within this distribution:
Operating Base Agent Server Console
System Product Layer Layer Layer
----------------- ----------------- ----- ------ -------
Solaris 2.5.1 SunMC 2.1.x x
Solaris 2.6-2.8 SunMC 2.1.x x x x
Windows NT 4/2000 SunMC 2.1.x/3.0 x
Informational Text Files
========================
A number of useful informational text files are included with this
distribution:
- README
- README.install
- TroubleShooting
- ReleaseNotes
- LICENSE
- COPYRIGHT
These files are located in the base directory of the distribution
tarball, and after installation, in the directory:
After installation on a Solaris host -
/var/opt/SUNWsymon/install/HALModScheduler
After installing the module's console layer on a Windows host -
C:\Program Files\Halcyon\PrimeAlert\docs\HALModScheduler
Installation and Uninstallation Instructions
============================================
For installation or uninstallation instructions, refer to the file
README.install (see the above section 'Informational Text Files').
Troubleshooting
===============
For troubleshooting information, refer to the TroubleShooting file
(see the above section 'Informational Text Files').
The release notes file, ReleaseNotes, which is located in the same
places as the TroubleShooting file, is also a valuable reference.
It contains information about bug fixes, enhancements, known problems,
and upgrade strategy for the current release.
HTML Help Documentation
=======================
To view the Help documentation for PrimeAlert ModuleScheduler, open
the following file in the "doc" subdirectory of the HALsmxsch_1.0.0
directory in the tar file HALsmxsch_1.0.0.tar:
./doc/HALModScheduler-h.html
This documentation is also available by selecting "Help" from the
module's pop-up menu in the console's Details window.
License
=======
Please read the license agreement in the file LICENSE located in this
directory.
Without purchasing a license, this module will only operate for a trial
period of 30 days.
If you wish to purchase a license to use PrimeAlert ModuleScheduler,
please contact us at:
Halcyon Monitoring Solutions, Inc.
2300 Yonge Street
Suite 1801, Box 2419
Toronto, Ontario M4P 1E4
Canada
http://www.HalcyonInc.com
mailto:info@HalcyonInc.com
Tel: 416-932-4647
Fax: 416-932-4711
Overview
========
PrimeAlert ModuleScheduler enables/disables other modules loaded on the
agent based on the output of a specified script. The purpose of the
ModuleScheduler is to provide the ability to schedule modules based
on a relative schedule (e.g. 5 minutes after a certain event) rather than
an absolute schedule provided by the attribute editor (e.g. 5:00PM on Tuesday).
An example of the usage of this module is to deactivate monitoring
on holidays. The provided HALModScheduler-holiday.sh script
will check whether the current date is a holiday (specified by rules
in a configuration file). When the day is a holiday, the controlled
modules will be disabled.
Another example of the usage of this module is to activate monitoring
on a cluster failover. The provided HALModScheduler-checkIP.sh script
will check for the existence of a virtual IP address created by the
cluster server. When the IP exists, the controlled modules will be
enabled. Conversely, when a failover occurs and the IP disappears,
the controlled modules will be disabled.
Loading an Instance of PrimeAlert ModuleScheduler
==================================================
1. Launch the Sun Management Center console application, and select a
domain that contains the host where PrimeAlert ModuleScheduler
will be loaded.
2. In a Host Details window, select "Load Module..." from the Module
Menu (or, in the Main console window, select "Load Module..." from a
host's Pop-up Menu).
3. Select PrimeAlert ModuleScheduler from the Module Picklist and
click on the OK button. This will launch the Module Loader which
contains the following fields:
Module
The name of the module assigned to files as part of the
module file naming convention. This field is read-only.
Module Name
The actual name of the module. This field is read-only.
Module Description
The short description of the module. This field is
read-only.
Version
The version number of the module. This field is
read-only.
Enterprise
The Enterprise where this module will be loaded in the
agent's MIB. This field is read-only.
Module Type
The module's type, which determines where this module
will appear in the module hierarchy. This field is
read-only.
Instance
Enter a short, alphanumeric description that has not been
used previously for other instances of PrimeAlert Module
Scheduler currently loaded on the same agent; this unique
description is used to differentiate the various
instances of PrimeAlert ModuleScheduler loaded on the same
agent. The description you enter here is appended to the
internal Module name described above.
For example, if the description "production" is entered
by the user, this instance is appended to the internal
module name "HALModScheduler" creating the following
unique instance name:
HALModScheduler+production
This instance name is useful in specifying alarm actions
using PrimeAlert EventAction.
Description
Enter a short, formal description of the module. This
description is used to identify the module in the console
window.
The short description you enter in this field will be
appended with the Module Name described above.
Script Name
Enter the name of the script, with a pathname relative to
"/var/opt/SUNWsymon/bin".
For security purposes, this script must be in the
directories mentioned, and it must be owned and
executable by user "root". On Windows machines, the
script must be readable by the user under whose account
the PrimeAlert Agent for Windows is running.
Script
Parameters
Enter the parameters (if any) to be passed to the script.
Script
Schedule
The script can be executed periodically. An example for
this is:
Cycle(5 Minutes)
To limit the period during which the script is executed,
use a time interval. An example is:
Hour >= 8 && Hour <= 17
You may use the Time Editor to create an advanced
periodic expression by clicking on the "Advanced..."
button. The following value for Script Schedule could be
used to execute the script every hour on weekends:
Day_of_week >= Saturday &&
Day_of_week <= Sunday &&
Cycle(1 hour)
4. Once you have entered the required information, click on the OK
button to load the module.
Trial Version Limitations
=========================
1. The trial version of this module will shut down 30 days after the
module is installed. The module can only be re-started after
purchasing a license.
2. The trial version of this module cannot be disabled. The module can
only be disabled and re-enabled after purchasing a license.
3. The active time window of the trial version of this module cannot be
altered. The module can only be scheduled on and off after
purchasing a license.
---//---