Home

	Expand Search

Configuring Adaptive Server for UNIX Platforms

Chapter 6 Licensing Adaptive Server Features

Chapter 6

Licensing Adaptive Server Features

This chapter describes how to add new licenses to existing servers using Sybase Software Asset Management (SySAM).

What is SySAM?

SySAM is a licensing mechanism that:

• Provides System Administrators the ability to monitor their site's use of Sybase products and optional features, and

• Grants access to select Sybase products and features.

Adaptive Server 11.9.3 uses SySAM to license optional features.

Adaptive Server features licensed through SySAM

Table 6-1 describes the Adaptive Server features that are licensed using SySAM.

How does SySAM work?

SySAM "checks out" licensed features to users, and checks them back in when they are no longer needed. The basic components of SySAM are:

• One or more Adaptive Server products with SySAM support

• One or more license files

• Asset management software, which consists of a license management daemon and a Sybase daemon

When you boot Adaptive Server 12.0, it looks for a license file named $SYBASE/$SYBASE_SYSAM/licenses/license.dat. If the file does not exist, Adaptive Server looks for the file specified in the environment variable LM_LICENSE_FILE.

The license file contains a pointer to the SySAM software, or to a remote machine on which SySAM is running. SySAM consists of two daemons--the license management daemon, lmgrd, and the SYBASE daemon--and utilities to manage licensing activities, lmutil. The daemons handle requests to check in or check out licensed features, as shown in Figure 6-1 .

Using information in the license file, Adaptive Server connects to SySAM and attempts to check out a license for the basic Adaptive Server product, ASE_SERVER. If the ASE_SERVER license is checked out successfully, Adaptive Server continues to boot and attempts to check out any optional features enabled in server_name.cfg.

If Adaptive Server is configured to use optional features, such as distributed transaction management or high availability, it attempts to check out licenses for those features during the boot-up process. If a license is unavailable for an optional feature, Adaptive Server still starts, but the feature cannot be used.

Types of SySAM systems

You can arrange the basic components of SySAM for a single standalone Adaptive Server, or for a collection of servers on a network.

In standalone systems, SySAM components reside on the same computer that runs Adaptive Server. Standalone SySAM systems can license either Adaptive Server alone or Adaptive Server with optional features.

Standalone system with no optional features

In a standalone installation where no optional Adaptive Server features are used, you do not need to run the asset management software. See Figure 6-2 . In this system, the license file contains all license information for ASE_SERVER. Adaptive Server obtains the basic license from the local license file and does not attempt to contact the license daemon software. No optional features can be used in this configuration.

Standalone system with optional features

In a standalone system where you have licensed optional Adaptive Server features, all of the SySAM components shown in Figure 6-1 reside on a single machine. The license file points directly to the asset management software, which runs on the same machine as Adaptive Server.

In a network system, a single machine called the primary network node runs SySAM. The software on the primary network node handles check in/check out requests from all other Adaptive Server instances in the system, as shown in Figure 6-3 .

In a network system, the license files for remote Adaptive Server installations contain only pointers to the primary network node. Servers check out individual licenses using the license files and asset management software that reside on the primary network node.

Setting up Adaptive Server with SySAM

The steps required to enable SySAM to track the functionality of Adaptive Server depend on the type of asset management system you want to use and on the Adaptive Server features you have purchased. Table 6-2 guides you through the setup process.

Enabling SySAM software

SySAM is installed with Adaptive Server.

If you licensed the Sybase Adaptive Server and other registered components when you installed them, SySAM is already enabled.

You must manually enable SySAM if:

• You did not register licensed products during Adaptive Server installation, or

• You add additional licensed products after Adaptive Server is installed.

Starting SySAM

If you are using a networked software asset management system, you must run the software on the primary network node before installing additional servers.

If you did not use SySAM to license Sybase server products during the unload process, use one of the following methods to start the asset management software manually:

• Use the UNIX command:

  $SYBASE/$SYBASE_SYSAM/bin/lmgrd  -c $LM_LICENSE_FILE &

• Run the startd.sh script in the $SYBASE/$SYBASE_SYSAM/bin directory.

Verifying that SySAM is running

When the lmgrd daemon starts, it automatically starts up the SYBASE daemon.

To verify that the license management software is running on the system, enter:

$SYBASE/SYSAM-1_0/bin/lmutil  lmstat -c

Make sure that both lmgrd and SYBASE are running before you continue the installation or start Adaptive Server.

Adding servers in a network asset management system

To prepare for installing additional Adaptive Servers with SySAM in a network asset management system:

• Make sure you have installed Adaptive Server and the asset management software on the primary network node. See Chapter 3, "Unloading Server Products from Distribution Media" in the installation guide for your platform.

• Make sure that the asset management software is running on the primary network node. See "Starting SySAM" .

• Make sure you have the printed Sybase License Certificates that contain your Adaptive Server and options key information.

• Collect the following information:

  • The host name of the primary network node

  • An unused port number on the primary network server node

  • The remote directory of the network server node on which the asset management software has been installed

Install the additional servers as instructed in the Adaptive Server installation documentation.

Adding a license for an existing server

If you did not license Adaptive Server at the time of installation, you can add a license for it.

To add a license for a basic Adaptive Server installation:

• Make sure the lmgrd and Sybase daemons are running:

  $SYBASE/$SYBASE_SYSAM/bin/lmutil  lmstat -c

• If the license daemon is not running, start lmgrd:

  lmgrd -c $SYBASE/$SYBASE_SYSAM/license.dat \
       -l $SYBASE$SYBASE_SYSAM/log/lmgrd.log&

• Run lmgr:

  $SYBASE/SYSAM-1_0/bin/lmgrd

• Provide the license information:

  • Order Number

  • Feature Name

  • Feature Count

  • Software Version

  • Authorization Code

• After the license has been added, run the license management utility lmutil lmreread in the $SYBASE/SYSAM-1_0/bin directory:

  lmutil lmreread

  The new license is appended to the license file.

Adding licences for new features after installation

After completing the initial installation of Adaptive Server, if you install additional components that require licenses, you need to update the license information.

To add additional licenses:

• Log on to the primary network node (server) that hosts the SySAM services.

• Make sure the lmgrd and Sybase daemons are running:

  $SYBASE/$SYBASE_SYSAM/bin/lmutil  lmstat -c

• If the license daemon is not running, manually start lmgrd:

  $SYBASE/$SYBASE_SYSAM/bin/lmgrd  -c $SYBASE/$SYSAM/licenses/license.dat     \-l $SYBASE/$SYSAM/lmgrd.log&

• Launch the license manager:

  $SYBASE/SYSAM-1_0/bin/lmgr

• When prompted: "Do you have Sybase Software Asset Management Certificates to register?" click Yes.

• The SySAM License Manager screen prompts you for:

  • Order Number

  • Feature Name

  • Feature Count

  • Software Version

  • Authorization Code

  Click More until you have entered all licenses. Click Done.

• Do the following:

  • Verify that SySAM is running:

    $SYBASE/$SYBASE_SYSAM/bin/lmutil  lmstat -c

  • Shut down the server to which you are adding the new license.

• Run the license management utility lmutil lmreread from the $SYBASE/$SYSAM/bin/ directory.

  $SYBASE/$SYBASE_SYSAM/bin/lmutil  lmreread

  The new license is appended to the end of the license.dat file.

Starting Adaptive Server with optional features

When you start Adaptive Server, it automatically tries to check out a license for itself (ASE_SERVER) and a license for each enabled optional feature.

You enable or disable optional features by using sp_configure. Table 6-3 lists the configuration parameters used to enable optional features.

By default, the configuration parameters for optional features are set to 0 (off). To enable an optional feature, use sp_configure to set its configuration parameter to 1, and reboot Adaptive Server. During the boot sequence, Adaptive Server attempts to check out licenses for all enabled features.

For information about configuring Adaptive Server as a companion server in a high availability system, see Using Sybase Failover in a High Availability System.

For information about configuring Adaptive Server with distributed transaction management, see Using Adaptive Server Distributed Transaction Management Features.

For information about configuring the other optional features, see Chapter 7, "Adding Optional Functionality to Adaptive Server" .

Troubleshooting SySAM

When you boot Adaptive Server, problems acquiring licenses or contacting the asset management software appear in the Adaptive Server error log file, $SYBASE/$SYBASE_ASE/$SYBASE_SYSAM/log/lmgrd.log.

Table 6-4 describes the SySAM error messages and suggests ways to correct common problems.

Use license file filename.

Feature feature_name is

not licensed.

There is no valid

license for ASE server product. Server is booting with all the optional

features disabled.

License manager initialization fails.

Feature feature_name is

over drafted n times.

Warning: ASE_DTM

does not have a valid license and therefore is not initialized.

Warning: ASE_HA does not have a

valid license and therefore is not initialized.

Warning: there is no valid license for

ASE_ASM and therefore feature ASM is not initialized.

Warning: there is no valid license for

ASE_JAVA and therefore feature JAVA is not initialized.

Authorization code input error

When you purchase licenses for Adaptive Server optional features, you are issued a Sybase Software Asset Management Certificate that includes the following information for each product:

• Order number

• Feature name

• Feature count

• Software version

• Authorization code

• Product description

SySAM builds the license file, license.dat, from this information. It appends new licenses to the end of the file.

The authorization code is case sensitive. If you make a mistake while entering the authorization code, correct it by accessing the license file with an ASCII text editor, making the necessary changes, and saving the file. The file is located in $SYBASE/$SYBASE_SYSAM/licenses/license.dat.

Warning!

Tampering with any portion of the license file other than the authorization code invalidates the license.

The format of a license file entry is:

INCREMENT ASE_FEATURE SYBASE nn.n license_type nnnn nnnnnnnnnnnn SN=nnnnn OVERDRAFT=nnnnn ck=nnnnn

where:

• ASE_FEATURE is the feature license name, such as ASE_SERVER, ASE_JAVA, etc.

• nn.n is the version number.

• license_type is the type of license, such as PERMANENT.

• nnnn is the feature count.

• nnnnnnnnnnnn is the authorization code.

• SN=nnnnn is the order number.

• OVERDRAFT=nnnnn is the maximum licenses that can be checked out.

• ck=nnnnn is the number of licenses checked out.

Here is a sample license file:

SERVER server1 ANY 4100
 
VENDOR  SYBASE $SYBASE/$SYBASE_SYSAM/bin/SYBASEUSE_SERVER
 
INCREMENT  ASE_SERVER SYBASE 12.0 PERMANENT 1000 123456789123 SN=10001  OVERDRAFT=10000 ck=0
 
INCREMENT  ASE_JAVA SYBASE 12.0 PERMANENT 1000 123456789123 SN=10001  OVERDRAFT=10000 ck=0
 
INCREMENT  ASE_DTM SYBASE 12.0 PERMANENT 1000 123456789123 SN=10001  OVERDRAFT=10000 ck=0
 
INCREMENT  ASE_HA SYBASE 12.0 PERMANENT 1000 123456789123 SN=10001  OVERDRAFT=10000 ck=0