Halcyon PrimeAlert (R) for Microsoft SQL Server
Version 1.0.3
For use with Sun Management Center
INSTALL.txt
-----------------------------------------------------------------------
Nomenclature
============
- 'Sun Management Center' was formerly called 'Sun Enterprise SyMON'.
This product only supports Sun Management Center 2.1 or higher.
- Halcyon has developed 'PrimeAlert Agents' for a number of platforms
(Windows NT 4 and 2000, HP-UX, and Linux) that allow non-Solaris
hosts to be monitored by Sun Management Center.
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.6-2.8 SunMC 2.1.x/3.0 x x
Windows NT 4/2000 PrimeAlert Agent x
for Windows
Windows NT 4/2000 SunMC 2.1.x/3.0 x
Installation Instructions
=========================
Definitions
-----------
ESROOT: This parameter only applies for a Solaris
installation host. For SunMC 2.1 or higher, this
directory is determined by the user while
installing SunMC; the default value is
/opt/SUNWsymon. To determine the value of ESROOT
on a SunMC agent host, run the command:
# echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"
Server Host: A host where the Sun Management Center server is
installed and running. This host must be a Solaris
host, and it contains the package SUNWessrv.
Agent Host: A host where a Sun Management Center or PrimeAlert
agent is installed and running. For this module,
it must be a Windows host that is running the
PrimeAlert Agent for Windows.
Console Host: A host where the Sun Management Center console is
installed and running. If this host is a Solaris
host, it contains the package SUNWescon; it may
also be a host running Windows.
Requirements
------------
PrimeAlert for Microsoft SQL Server is intended for use with the
PrimeAlert Agent for Windows on a host running Windows NT 4 or later.
In addition to the PrimeAlert agent, a Sun Management Center 2.1 or
later server layer (Solaris) and a Sun Management Center 2.1 or later
console layer (Solaris or Windows) are needed.
You have administrative privileges on the Windows system upon which you
will be installing the module.
The Windows system has MS SQL Server installed on it, or the MS SQL
Server Client utilities, or a recent Microsoft Data Access package
(MDAC).
This module supports versions 6.5 and 7.0 of Microsoft SQL Server.
Extracting the Distribution File
--------------------------------
The PrimeAlert for Microsoft SQL Server distribution file,
HALSQLServer_1.0.3.tar.(Z|gz), must be extracted on a Solaris host
before any packages can be installed. For example, assume that the
distribution file has been copied to the /tmp directory, and will be
extracted there. In this case, the procedure for extracting the
distribution file is:
% su -
# cd /tmp
# uncompress HALSQLServer_1.0.3.tar.Z
or gzip -d HALSQLServer_1.0.3.tar.gz
# tar xvf HALSQLServer_1.0.3.tar
In this case, the directory /tmp/HALSQLServer_1.0.3 represents the
installation source directory, <SOURCE_DIR>, which is referenced below.
Server Layer Packages - Solaris Only
------------------------------------
The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.
Note that server layer packages should be installed/upgraded before
agent or console layer packages are installed/upgraded.
Login to the Sun Management Center server host as root. Extract the
PrimeAlert for Microsoft SQL Server distribution file (see the above
section 'Extracting the Distribution File') in a temporary location,
and then run the script HALSQLServer-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALSQLServer-install.sh -s
The following package is installed or upgraded by the installation
script:
- HALmmswsq
Console Layer Packages - Solaris
--------------------------------
The procedure described in this sub-section should be performed on any
console host that is being upgraded to the latest version of PrimeAlert
for Microsoft SQL Server, or that is receiving the module for the first
time.
Login to a Sun Management Center console host as root. Extract the
PrimeAlert for Microsoft SQL Server distribution file (see the above
section 'Extracting the Distribution File') in a temporary location,
and then run the script HALSQLServer-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALSQLServer-install.sh -c
The following package is installed or upgraded by the installation
script:
- HALmmcwsq
The local SunMC console should be restarted after installation.
Agent and Console Layer Packages - Windows
------------------------------------------
The procedure described in this sub-section should be performed on
any Windows console or agent host that is being upgraded to the
latest version of PrimeAlert for Microsoft SQL Server, or that is
receiving the module for the first time.
1. Extract the PrimeAlert for Microsoft SQL Server distribution file
(see the above section 'Extracting the Distribution File') on a
Solaris host. In this case, the InstallShield installer for Windows
has the pathname:
<SOURCE_DIR>/packages/win32/HALSQLServer_1.0.3.exe
2. Copy the Windows InstallShield installer to a convenient location
(<path>) on the Windows agent/console host.
3. If present, remove the currently installed console/agent packages
for PrimeAlert for Microsoft SQL Server (see the following section
'Removing Agent and Console Layer Packages - Windows').
4. Run the InstallShield package HALSQLServer_1.0.3.exe, for
example:
Start->Run... <path>\HALSQLServer_1.0.3.exe
Follow the instructions presented on screen. You can choose to
install console layer files, agent layer files, or both.
If you choose to install the agent layer of PrimeAlert for
Microsoft SQL Server, then:
(i) During installation it is possible to configure the module
for use with a particular Microsoft SQL Server and ODBC DSN. This
will configure the module appropriately and restart the agent,
which will automatically load the pre-configured module, as well
as allow the console to see the module in a console's Module
Pick List.
The following parameters need to be supplied:
- Instance: The name of the module instance. Due to SNMP
limitations, the instance must not exceed a length of 15
characters, and it may not contain spaces or special
characters. The default value is
mssql_<name of the computer>
- Description: A short description for the module instance. The
default value is
<name of the computer>
- Server Directory: Installation directory of Microsoft SQL
Server. The default value is the corresponding entry in the
Windows registry, e.g.
D:\MSSQL
- Account: The user name with which to connect to the database.
Since the automatically-configured DSN uses a trusted
connection, this account name is not used, but is necessary for
proper configuration. The default value is
sa
Please read the "Security and Access Issues" section of the
file README.txt.
- Password: The password with which to connect to the database.
Since the automatically-configured DSN uses a trusted
connection, this password is not used, but is necessary for
proper configuration.
- DSN Name: The name of the ODBC DSN. The default value is
<name of the computer>_Halcyon_SQLServer
- Driver: The driver for the ODBC DSN. The default value is the
corresponding entry in the Windows registry, e.g.
C:\WINNT\System32\sqlsrv32.dll
- Description: A short description for the ODBC DSN. The default
value is
DSN on colorado for PrimeAlert for Microsoft SQL Server
- Server Name: The name of the host running the Microsoft SQL
Server. The default value is the host on which the module is
being installed
<name of the computer>
After supplying the necessary information, the user can test the
connection to the database by clicking on the "Test ODBC DSN"
button in the configuration dialog. Any error or status messages
appear to the right of the button.
Upon clicking the "Next" button, the module is configured and a
new ODBC DSN entry for use with the module is created.
(ii) If the module is not automatically configured during
installation, the following must be done after installation:
a) Add an ODBC System DSN (Data Source Name). This can be found
in the control panel's ODBC Data Sources' utility, in the
System DSN tab.
If possible it is recommended that a system DSN be created that
uses Integrated Security, and the user under whose authority
the Halcyon PrimeAlert Agent service runs under should be given
administrative authority within the database. This typically
means adding that user to the NT Domain group that is being
used for the MS SQL server administrative authority.
The security choices and implications are discussed in the
"Security and Access Issues" section of the README.txt file.
It is suggested that a system DSN be created specifically for
this module's use. To keep things unambiguous, we recommend the
DSN be named after the MS-SQL server's hostname postfixed by
"_Halcyon_SQLServer", or some other term that identifies what
the DSN's use is. Otherwise accept all the defaults.
b) Ensure the Halcyon PrimeAlert agent service is running under
a user's authority. Typically this will be a domain user
created specifically for this service or for datacenter
processes, services, and tasks, who has been granted admin
authority in the enterprise's MS SQL Servers. This domain
user's account must be set to never expire and never require
the password be changed, and should never be used to log into a
system interactively.
c) Stop and re-start the Halcyon PrimeAlert agent service.
d) Load the module. See the README.txt's loading section.
Besides installing a number of program files, the installation
program puts a shortcut in the Start Menu's Programs folder,
sub-folder Halcyon. This shortcut provides easy and fast access
to help files for PrimeAlert for Microsoft SQL Server.
If Windows console layer packages have been installed/updated, the
local SunMC console should be restarted after installation.
Installation Log File - Solaris Only
------------------------------------
To view the installation log on a Solaris host, see the file:
/var/opt/SUNWsymon/install/HALSQLServer-install_<YYYYMMDD>-<HHMMSS>.log
Uninstallation Instructions
===========================
Removing Server Layer Packages - Solaris Only
---------------------------------------------
The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.
Login to the Sun Management Center server host as root, and then run
the following commands:
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module SQLServer server
The following package will be removed:
- HALmmswsq
Removing Console Layer Packages - Solaris
-----------------------------------------
The procedure described in this sub-section should be performed on any
console host where packages for PrimeAlert for Microsoft SQL Server are
to be removed.
Login to a Sun Management Center console host as root, and then run
the following commands:
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module SQLServer console
The following package will be removed:
- HALmmcwsq
It is not necessary to restart the local SunMC console after package
uninstallation.
Removing Agent and Console Layer Packages - Windows
---------------------------------------------------
The procedure described in this sub-section should be performed on any
Windows host where PrimeAlert for Microsoft SQL Server is to be
removed.
1. If PrimeAlert for Microsoft SQL Server is loaded as a module on the
agent where PrimeAlert for Microsoft SQL Server is being removed,
then unload PrimeAlert for Microsoft SQL Server from the agent.
2. Go to the Windows Start menu and select:
Start -> Settings -> Control Panel
A new Control Panel window will appear on your screen.
3. Double-click on the "Add/Remove Programs" icon in the Control Panel
window. A new window labeled "Add/Remove Programs (Properties)" will
appear.
4. Select "Halcyon PrimeAlert for Microsoft SQL Server" in the
scrolling list of the new window.
Windows NT 4 --
Click on the "Add/Remove..." button.
Windows 2000 --
Click on the "Change/Remove" button.
An UnInstallShield session will be launched; follow the instructions
presented on screen.
Uninstallation Log File - Solaris Only
--------------------------------------
To view the uninstallation log on a Solaris host, see the file:
/var/opt/SUNWsymon/uninstall/log/uninstall.log.<YYYYMMDD>-<HHMMSS>
---//---