SySAM
stands for Sybase Software Asset Management. It is used to manage licensed
Sybase products. SySAM is used in ASE 12.0 and above. These features are
licensed for customer use with paper-based 'SySAM Certificates'.
For ASE 12.0 there are 4 SySAM licensed features:
| ASE_HA |
(High Availability System features) |
| ASE_DTM |
(Distributed Transaction Management) |
| ASE_JAVA |
(Java in the Database) |
| ASE_ASM |
(Advanced Security Mechanisms (SCL)) |
Starting with ASE 12.5 there are 6 additional licensed features:
| ASE_EFTS |
(Enhanced Full Text Search) |
| ASE_EJB |
(Enterprise Java Bean Server) |
| ASE_SXP |
(SQL Expert) |
| ASE_XFS |
(External File System Access through proxy tables) |
| ASE_DBXRAY |
(DBXray) |
| ASE_DIRS |
(LDAP Option) |
Lastly, starting with ASE 12.5.0.1, feature licenses will be available
in license packages:
| ASE_SECDIR |
(Security & Directory Services) |
| ASE_XMLMGMT |
(XML Management) |
| ASE_CONTMGT |
(Content Management) |
| ASE_EBIZ |
(eBusiness Enterprise) |
| ASE_WEBSERVICES |
(Web Services) |
| ASE_DRECOVERY |
(Disaster Recovery) |
There are 3 versions of ASE:
| ASE_SERVER |
(ASE Enterprise Edition) |
| ASE_SBE |
(ASE Small Business Edition) |
| ASE_DEV |
(ASE Developer Edition) |
Currently, each Server is shipped with a customer-specific ASE_SERVER, ASE_SBE or ASE_DEV
Certificate. This certificate should be installed regardless of whether or not you have additional
feature licenses. A Server license, either ASE_SERVER, ASE_SBE or ASE_DEV, must be
installed in order for the other optional features to run.
At server startup, each ASE server checks the license file in
its environment for permission to run specific features. In order for the
server to do this, a license manager and a vendor module must be running.
You can interact with SySAM at four specific times:
1. At installation time
2. At feature-addition time
3. At usage-monitoring time
4. When troubleshooting license issues
SySAM can be installed in local mode or network mode. In local mode,
each ASE host machine has a local license manager. In network mode, several
networked ASE host machines refer to one central license manager host to
get the license information.
This paper will deal with the most common mode, the local mode, in detail.
I. INSTALLATION
SySAM is delivered and installed with the ASE 12.x product. Check carefully
for the ASE_SERVER License Certificate included with each server and keep
this available during installation. If you ordered optional feature licenses,
they are included with the ASE_SERVER certificate. Several certificates
may be included on a single sheet of paper. A SySAM License Certificate
will have the following information:
| Order Number: |
Use the complete order number, including the hyphen if the order number
has one, when entering this information. |
| Feature Name: |
ASE_SERVER, ASE_HA, ASE_DTM, etc. (only one). |
| Feature Count: |
The number of servers that can use this feature concurrently. |
| Software Version: |
12.0 or 12.5 (be sure to enter what is on the certificate). |
| Authorization code: |
Enter this character string exactly as found on the certificate. |
| Product Description: |
Short description of the option. |
The Studio Installer unloads and installs the ASE 12.x product from
the CD. Immediately afterwards (on UNIX), or after reboot (on NT), SySAM
is invoked to begin Certificate Registration. A Sybase License Management
window will open and ask the question:
"Do you have a Sybase Software Asset Management Certificate to Register?"
For a local SySAM license manager, the answer is YES. After answering
YES, a "feature-line entry" window will appear. Completely fill all entries
in this window with the information from your ASE_SERVER License certificate.
When finished, click on "more" if you have additional certificates to
add, "reset" to clear all current window entries and start all over, or
"Continue Install". After clicking on "Continue Install" you are asked
to enter the License Manager host name and Port number. The local machine
name is the default host name and a default port number is 29722. If the
host name is incorrect, correct it and then enter the actual port number
you want to use. (If 29722 is not being used, you may use this - the decision
is yours). Click the OK button to complete the installation.
For a Networked SySAM registration, the certificate must be entered
at the central SySAM license manager host. In this case, when the first
question is asked:
"Do you have a Sybase Software Asset Management Certificate to Register?"
Answer "No". A different window opens and asks the question:
"Have you registered your Sybase Software Asset Management Certificates
at a central license host"?
Assuming you have done this, answer "Yes".
You now get a window asking you to enter the License Manager Host and
Port number. Change the default entries to match the host name and port
number of your central license manager. After making these changes, click
OK to complete the installation.
After completing the installation, you must also enable the licensed
optional features in the server using the sp_configure command:
sp_configure "enable ha", 1
sp_configure "enable dtm", 1
sp_configure "enable java", 1
sp_configure "use security services",
1
sp_configure "enable full text search",
1
sp_configure "enable enterprise java
beans", 1
sp_configure "enable file access",
1
sp_configure "performance monitoring
option", 1
After enabling the features in the Adaptive Server, restart the Adaptive
Server. This is needed because the License file is read only at startup
time.
II. Adding License Certificates
Three steps are required to add new features. These steps can also be used
to add a newer License certificate for a current feature.
First, you must register the new feature. You do this by invoking the
License Manager:
| |
For UNIX:
$SYBASE/SYSAM-1_0/bin/lmgr |
| |
For NT:
Start -> Programs -> Sybase
-> "Sybase Software Asset Mgmt" |
You will go through the same windows as during installation. Enter all
of the information from the new certificate(s).
Second, make the license manager daemon read the license file again.
This can be done using lmutil with the lmreread parameter.
For UNIX:
Source $SYBASE/SYBASE.csh
Verify that the environment variable LM_LICENSE_FILE is set properly.
(The default setting is $SYBASE/SYSAM-1_0/licenses/license.dat )
Enter command: $SYBASE/SYSAM-1_0/bin/lmutil
lmreread
For Windows NT, in a DOS window
run:
%SYBASE%\SYSAM-1_0\bin\lmutil lmreread
If the license manager daemon is not currently running, when you start
the daemon it will read the license.dat file.
Third, set the appropriate Adaptive Server configuration parameter and
restart the Adaptive Server to read the new or updated license file.
After Adaptive Server starts, check the errorlog to see that the options
have been enabled. The "enabled" messages will appear at the beginning
of the startup sequence in the errorlog.
IIa. Package Licenses
You must be running ASE 12.5.0.1 or later in order to use License Packages.
A package license is a FEATURE line for a package, or suite, of licenses.
A package is several ASE licenses bundled together. By providing packages,
Sybase makes it easier for the customer to install the necessary license
for various uses. The packages currently available are:
| ASE_SECDIR |
(Security & Directory Services) |
| ASE_XMLMGMT |
(XML Management) |
| ASE_CONTMGT |
(Content Management) |
| ASE_EBIZ |
(eBusiness Enterprise) |
| ASE_WEBSERVICES |
(Web Services) |
| ASE_DRECOVERY |
(Disaster Recovery) |
A package has both PACKAGE lines and FEATURE lines. Sybase provides
the package lines in the sybpkg.dat file, found in $SYBASE/SYSAM-1_0/licenses/.
These package lines will not, themselves, provide any licensing. They work
together with the feature line provided in a License Certificate for the
package. The sybpkg.dat file must be added to the environment variable
LM_LICENSE_FILE in order to be read by the License Manager.
The FEATURE line is the actual license certificate provided by Sybase
to license the package. This feature line is added to the license.dat file.
Two steps are necessary for a package license:
1. Add the sybpkg.dat file to the environment variable LM_LICENSE_FILE.
Note:
You may or may not have the LM_LICENSE_FILE variable explicitly set.
Its default setting is:
$SYBASE/SYSAM-1_0/licenses/license.dat
You must add $SYBASE/SYSAM-1_0/licenses/sybpkg.dat to LM_LICENSE_FILE,
separating the file names with colons. Set the LM_LICENSE_FILE environment
variable to:
$SYBASE/SYSAM-1_0/licenses/license.dat: $SYBASE/SYSAM-1_0/licenses/sybpkg.dat
2. Follow section II above and add the package certificate (FEATURE
line) to the license.dat file. Be sure to run lmutil lmreread
so that the license manager daemon reads the new information.
Beginning with ASE 12.5.1, the information in sybpkg.dat is copied to the license.dat file by lmgrd
when you enter a license. This makes the added entry in the LM_LICENSE_FILE environment variable
(for sybpkg.dat) unnecessary, but we recommend you still add it.
III. Monitoring Usage
To monitor basic statistics on feature usage and environment, run the following
command:
| |
Source $SYBASE/SYBASE.csh. |
| |
Verify that the environment variable LM_LICENSE_FILE is set properly.
(The default setting is $SYBASE/SYSAM-1_0/licenses/license.dat ) |
| |
Enter command: $SYBASE/SYSAM-1_0/bin/lmutil
stat -a |
| |
For WINDOWS NT, in a DOS window run: |
| |
%SYBASE%\SYSAM-1_0\bin\lmutil stat
-a |
IV. Starting and stopping the License Manager
Use the following commands to start the License Manager:
For UNIX:
$SYBASE/SYSAM-1_0/bin/lmgrd
-c license_file_path:license_package_path -l logfile
&
Unix default for license_file_path:license_package_path
$SYBASE/SYSAM-1_0/licenses/license.dat:$SYBASE/SYSAM-1_0/licenses/sybpkg.dat
For WINDOWS NT:
%SYBASE%\%SYSAM-1_0%\bin\lmgrd -app
-c license_file_path:license_package_path -l
logfile
Windows default for license_file_path:license_package_path
%SYBASE%\SYSAM-1_0\licenses\license.dat:%SYBASE%\SYSAM-1_0\licenses\sybpkg.dat
Use the following commands to stop the License Manager:
For UNIX, enter the command:
$SYBASE/SYSAM-1_0/ bin/lmutil lmdown [-q]
Note:
If you do not want to be asked the question "Are you sure? [y/n]: .",
use the parameter -q
For WINDOWS NT, in a DOS window run:
%SYBASE%\SYSAM-1_0\bin\lmutil lmdown [-q]
Note:
If you do not want to be asked the question "Are you sure? [y/n]: .",
use the parameter -q
To set up the License Manager to run as a SERVICE, execute the 'installs.exe' program which is found in the following directory:
c:\%SYBASE%\SYSAM-1_0\bin\installs.exe
V. Troubleshooting License Issues
If all goes well, your licensed options should be enabled after you start
your server. These can be confirmed by querying the system with
sp_configure
<option name>. This returns a row of information about the configuration
parameter. If the option was successfully enabled, the run value will be
"1"(one). If it was not enabled, the run value will be "0" (zero) and there
will be an error message in the error log at the beginning of the server
startup indicating no license was available, for example:
Feature
ASE_JAVA is not licensed.
If you have a problem with a licensed feature, the following steps should
help you to resolve the problem.
Step 1. Check to be sure that the license manager daemon, lmgrd,
and the vendor daemon, SYBASE, are running. In UNIX, do a ps
command and check for processes with these names:
In NT, go to the task manager and check in the processes folder for:
If these are not running, the license file is not accessible and no
licensed features will be enabled.
Step 2. Execute sp_configure <option name> to check if the
option was enabled. Check the configured value for a 1 (one). If the configured
value is 0 (zero), the feature was not enabled in the server. You must
use sp_configure to enable the feature, then reboot the server so
that it checks the license file again.
Step 3. Print or display the license.dat file and check the entries
to be sure you entered each license information correctly. The first three
lines (using local license manager) should be:
SERVER <name
of lmgrd host> <port number>
VENDOR SYBASE <fully
qualified path to the SYBASE executable>
USE SERVER
Following these three lines there should be an INCREMENT line for each
feature option.
The following is a correlation between the fields in the INCREMENT lines
and the License Certificate:
| License.dat |
Certificate |
Derived value |
| First parameter |
Feature Name |
|
| Second parameter |
|
SYBASE |
| Third parameter |
Software Version |
|
| Fourth parameter |
|
PERMANENT |
| Fifth parameter |
Feature Count |
|
| Sixth parameter |
Authorization Code |
|
| Seventh parameter(SN=) |
Order Number |
|
| Eighth parameter |
|
OVERDRAFT=10000 |
| Ninth parameter |
|
ck=0 |
Step 4. If all of the above steps appear to be correct and you still
have an error message in the error log indicating the feature is not licensed,
find the license manager errorlog and check it for errors. For a local
license manager, the errorlog can be found at:
UNIX: $SYBASE/SYSAM-1_0/log/lmgrd.log
NT: %SYBASE%\SYSAM-1_0log\lmgrd.log
The following section describes the most common errors and what to do
about them:
1.
| Symptom: |
Bad code or inconsistent encryption code. |
| Cause: |
Possible causes for this are: 1) the license
file was modified (either the hostid on a SERVER line or anything on the
FEATURE line was changed); 2) the vendor used the wrong version of his
license creation program to generate your license file (or there is a bug
in that process); 3) the license certificate is incorrect. |
| Solution: |
You should not modify the license file. If you
need to change something in your license file, you should rename the current
license.dat
to license.xxx and re-enter the license information. If you suspect
the certificate is incorrect, contact Sybase. |
2.
| Symptom: |
When I run the license manager on my machine,
it tells me it is the wrong hostid. |
| Cause: |
The vendor daemon checks the hostid listed on
the SERVER line in the license file; if it does not match the hostid of
the machine it is running on, this message will be printed. Possible causes
include:
1) You are trying to run the license server on a different machine
from the machine for which the file was made
2) The host id of the machine you are running on changed
3) The hostid in the license file was modified |
| Solution: |
Verify that the host id of the machine on which
the vendor daemon is being run matches the host id specified in the license
file (on the SERVER line). |
3.
| Symptom: |
When I start up lmgrd, it says execl
failed on my vendor daemon. |
| Cause: |
lmgrd uses execl to start each vendor
daemon running. If there is a problem starting the vendor daemon, this
message is output to the log file. This error is typically caused by one
of the following:
1) there is no executable at the location referred to by the license
file (and printed out in the log file);
2) the executable does not have the proper permissions to be run (the
file does not have the "x" bit set or one of the directories in the path
is not readable);
3) there was an error building the executable, and it cannot be run;
4) the executable is for a different machine architecture. |
| Solution: |
Verify that the path to the vendor daemon is
absolute (i.e., starts with a slash character and that it points to the
executable program itself, not the containing directory). Ensure that the
file exists as the vendor daemon file name(s) specified in the log file.
Make sure you check this as the same user that started lmgrd. Verify
that the file is executable. |
4.
| Symptom: |
The License Manager reports in the error log:
(SYBASE) cannot establish lock - existing
(file:/usr/tmp/lockSYBASE, error 11) - or in Windows NT - (file:C:\flexlm\SYBASE)(lmgrd)
MULTIPLE 'SYBASE' servers running.
. |
| Cause: |
There is more than one SYBASE vendor daemon
running. |
| Solution: |
This error probably results from either:
1. Another copy of lmgrd is running
2. A prior lmgrd was killed with kill -9, which would
leave the vendor daemon running.
To correct this, in UNIX do a ps -ax | grep SYBASE and kill the
SYBASE process(es). In NT, check the running processes and stop any SYBASE
processes. Then run lmutil lmreread (if the current lmgrd
is running) or restart the license manager. |
5.
| Symptom: |
The license manager keeps reporting "lost lock"
errors in the log file and exiting. |
| Cause: |
The lock file (lockSYBASE on UNIX, normally
placed in /usr/tmp; SYBASE on Windows NT, normally placed in C:\flexlm)
is being removed by someone else. There could be another daemon running,
or the license administrator (or a script he set up) could have deleted
the file. |
| Solution: |
Check to see if there is more than one copy
of the daemon running. On UNIX use a command like ps -aux | grep
vendor to search for it. Check for more than one lmgrd running as
well, since it will restart your vendor daemon when it is killed. If more
than one lmgrd is running, kill them all (using the kill
command, not kill -9, on UNIX or lmtools on Windows NT),
then kill any remaining vendor daemons (on UNIX, try a simple kill, if
that fails then try kill -9 the lmgrd and all vendor daemons)
and start one fresh copy of lmgrd. On UNIX, check to see if there
is a shell script running that cleans out /tmp (or /usr/tmp).
If so, try modifying it so that it does not delete zero-length files. |
For other errors, refer to the Globetrotter FLEXlm End User Manual.
If you are still having trouble, call your local Technical Support Center.
The Support Engineer will need the following information to troubleshoot
the problem:
| |
Adaptive Server error log |
| |
lmgrd log (License manager log at $SYBASE/SYSAM-1_0/log/lmgrd.log) |
| |
License file ($SYBASE/SYSAM-1_0/licenses/license.dat) |
| |
License Certificates |
