Solstice Enterprise Manager 4.1 Installation Guide | ![]() ![]() ![]() ![]() ![]() |
Administering Licenses
Some Solstice Enterprise Manager (Solstice EM) software components require a license to use them. You can obtain licenses for these components before installing Solstice EM software. You can then enter the licenses during installation, and the setup program will install them for you.
You must install the licenses before using any of the components that require licenses. If you did not install licenses during the installation, you can install them by running the lit program.
This chapter discusses how licensing works, the types of licenses available, how to obtain a license, how to set up a license server, and how to manage licenses.
This chapter describes the following topics:
- Section 5.1 Licensed Components
- Section 5.2 How Licensing Works
- Section 5.3 License Types
- Section 5.4 Installing Solstice EM Licensing
- Section 5.5 Starting License Manager Daemons
- Section 5.6 About License Data Files
- Section 5.7 Combining License Files
- Section 5.8 Adding New Products to an Existing License File
- Section 5.9 Managing Licenses
- Section 5.10 Manual Pages
5.1 Licensed Components
The following components of Solstice EM require licenses:
- CMIP 9.0 for SPARCTM--one license is required for CMIP 9.0.
- Common Management Information Protocol (CMIP) Management Protocol Adapter (MPA) (TMNQ3)--one license is required for each instance of the CMIP MPA.
- Client applications--one license can be shared by all client applications, as long as they are started by the same user on the same client machine.
- Management Information Server (MIS)--one license is required for each instance of the MIS.
- ToolKit--one license is required for the Solstice EM development environment.
- Java DMK Protocol Adapter--one license is required for each instance of the Java DMK Protocol Adapter.
Note For SEM-HA, the above individual component licenses should be installed on all the nodes.
5.2 How Licensing Works
The Solstice EM CD-ROM contains software that you install on your network to manage concurrent (shared) licenses.
Inside your Solstice EM product kit, you will find a certificate. This certificate corresponds to a license for a number of Rights to Use (RTU) for one or more Solstice EM components.
The licensing mechanism requires the following:
- License manager daemon - The license manager daemon runs on the network.
- License server - The machine that runs the license manager daemon is the license server. The license server must be a SolarisTM system.
- License data file - The license data file contains the information that makes licensing work. It is installed on the license server.
- License database - One or more license data files constitute the license database.
- Serial number - The serial number is on the license certificate included with your software. You need this number to get your license password.
- License distribution center - You must call a license distribution center with the serial number and information about your license server in order to obtain the license password to enter into the data file.
- License password - A license key (password) is assigned to each feature for which you have a valid license.
Whenever a program starts, it must first obtain a license from the license database. This database can be local to the machine (an individual license) or located on a license server (a shared license).
When you run a program, the program reads the license database or sends a message to the license daemon asking for a license. If a license exists in the license database, the program runs. If the license database is located on a license server, the computer running the program must be able to connect to that server.
5.3 License Types
Permanent licenses can be either concurrent (shared) or node-locked (local to the individual machine). An evaluation license is local to the individual computer.
- A concurrent license is shared among many users. In order to use concurrent licensing, the administrator must set up a license server with a centrally administered license database on a network. This is the preferred method for licensing Solstice EM components.
- A node-locked license is permanently assigned to an individual computer (or node). This type of license does not require a license server.
- An evaluation (demo) license has a built-in expiration date. This allows you to use an application for a restricted time period (generally thirty days). If you have installed Solstice EM software with an evaluation license, you must replace the evaluation license with a permanent license within the time period if you want to continue using the software. A warning message will appear when the expiration date approaches. Install a permanent license using the License Installation Tool.
5.4 Installing Solstice EM Licensing
The following sections provide a quick overview of how to set up licenses at your site. If you are using only node-locked licenses, you do not need to set up a license server. Setting up a license server involves these tasks:
- Selecting the license server(s)
- Installing the licensing software on each server
- Obtaining a license and password
- Activating the license
5.4.1 Selecting a License Server
Before you install and run the licensing software, you need to select a license server and obtain the host name and host ID to be provided to the license distribution center.
You should choose a stable machine to function as your license server. Do not choose a machine that must be frequently shut down and restarted.
Note Once you have selected a machine as a single, multiple, or redundant license server, that machine cannot be used in a different licensing configuration.
With this licensing system, you can use any of the following types of license server configurations:
- Single independent server
- Multiple independent servers
- Redundant servers
5.4.1.1 Single Independent Servers
All licenses are handled by a single server. You can have any number of independent servers and divide your licenses among them. The default is a single server. A single server is the easiest to install and is recommended.
5.4.1.2 Multiple Independent Servers
Each server acts separately to administer a subset of licenses.
5.4.1.3 Redundant Servers
Three servers act as one server, administering the same set of licenses. You can set up three redundant servers to manage the same set of licenses. The set of servers operate as one logical server. If one server is unavailable, the applications will be able to acquire a license from one of the other servers.
The licensing software requires that a majority of redundant servers be running. If you have three redundant license servers, two must be running. If only one of a three-servers configuration is running, then no licenses will be available.
To set up the redundant servers, you must provide the host IDs for all three machines to the license distribution center when you call for your license password. All server host IDs are incorporated into the license password and any servers that are not incorporated into the password will not work.
If you choose to use redundant servers, all your licenses installed on those machines must use the same redundant servers. If, for example, you purchase a license for a product to be served by servers A, B, and C, then any new licenses added to one of those servers must be added to the other two servers with the same configuration as the first license.
The main advantage of redundant servers is the probability that all licenses will be available. However, there is the risk that if two of the three license servers are down, then no licenses are available.
5.4.2 Installing the Licensing Software
Before the licenses can be installed, the licensing software, comprising the STE Licensing Tool (SUNWlit package) and the FlexLM License Manager (SUNWlicsw package) must be installed. You can use the setup program to install these packages at any time prior to or after installing the rest of the software.
If you installed the License component, the licensing software is already installed. Type the following command to check if the licensing software already exists on your system:
pkginfo SUNWlicswIf the SUNWlit and SUNWlicsw packages already exist, go to Section 5.4.4 Activating the License." If not, then you must follow the instructions in this section to add the packages using the pkgadd command.
![]()
To Install the License Software
To install the licensing software, perform the following steps as root:
1. Change to the directory where the CD-ROM is mounted.2. Type the following command:
pkgadd -d . SUNWlicsw SUNWlit
- After you press Return, the packages are installed. During the installation, if you see questions pertaining to the subjects listed below, enter y if you want to continue, or n if you do not:
- Executing scripts with superuser permissions
- Installing files with setuid and/or setgid permissions
- The installation is complete when your prompt re-appears.
- After running SUNWlit on your license server, two things are accomplished by the program:
- It automatically generates the file, licenses_combined. This file is used by the license daemon, and is located on the license server in /etc/opt/licenses/licenses_combined
- It starts or restarts the license daemons.
5.4.3 Obtaining a License and Password
This section describes how to contact the license distribution center to obtain your license. Acquiring a license involves the following tasks:
- Gathering the necessary information
- Contacting the license distribution center
- Receiving the license password
Once you have collected the necessary information, you can obtain your license password from one of the license distribution centers. The license distribution center will give you the choice of delivery by voice, email, or fax.
5.4.3.1 What You Will Need to Provide
Before you contact the license distribution center, gather the following information:
- Serial number from the license certificate. Your Solstice EM component includes a license certificate with the following information:
- Host ID of the license server (three host IDs if you are using redundant servers). To get the host ID of your system, type hostid.
- Host name of the license server (three host names if you are using redundant servers). To get the name of your server, type uname -n or hostname.
5.4.3.2 Contacting the License Distribution Center
You can contact the license distribution center by email, fax, or telephone. The phone numbers for most of the license distribution centers are provided on the proof of your license certificate. Email addresses are also listed.
Note If you receive your license password by email, the License Installation Tool can read the licensing information directly from the email file sent from the license distribution center. See To Load Your License Data From a File.
- United States, Canada, and Puerto Rico - license@sun.com
- Europe - eu-licensing@UK.sun.com
- Japan - japan_licensing@Japan.sun.com
- All Other Countries - license@sun.com
Once you have contacted the license distribution center, you will receive one of the following:
- email - You will receive a license file for the licensed features. The entire file can be read into the license database using the License Installation Tool.
- Fax or phone - You will receive the following information, which you can enter into the database using the License Installation Tool:
5.4.4 Activating the License
Before activating the license, complete the procedures in the previous subsections of Section5.4 Installing Solstice EM Licensing."
There are two methods for activating the license:
- Load license data into the license file automatically
- Type license data into the license file manually
You must be superuser to enter license passwords.
![]()
To Load Your License Data From a File
If you receive your license by email, you can easily load your license data (and avoid mistyped information) into a license file. This method creates a new file or adds to an existing one.
1. Save as a file the email message you received from the license distribution center.
- The license file might be included as an attachment.
2. As root, start the License Installation Tool. Type: /etc/opt/licenses/lit
- The License Installation Tool opens on your desktop.
3. Select "Loaded From An email Message Saved To A File".4. Type the absolute path name of the saved file containing the license, then click Load License Information From File or click browse button.
- The License Installation Tool displays the licenses in a window.
5. Do Load File.6. Click Install.
- The License Installation Tool installs the licenses on your server and displays a message stating that the licenses are installed.
- When the licenses are installed, the license configuration script, LIC_CONFIG_SCRIPT, runs on the server where you ran lit.
7. If you have redundant servers, perform the following steps.
- Copy file /etc/opt/licenses/LIC_CONFIG_SCRIPT from the license server where you ran lit to the remaining redundant license servers.
- Run the configuration script on each of the redundant servers by typing:
/etc/opt/licenses/LIC_CONFIG_SCRIPT
- This command puts a copy of the license file on each of the redundant license servers in /etc/opt/licenses/licenses_combined file.
- Look in log file /tmp/license_log for any errors.
- Repeat these steps for each redundant server.
![]()
To Type Your License Data Manually
You must be superuser to install the license passwords using the License Installation Program.
1. As root, start the License Installation Tool. Type the following command:
/etc/opt/licenses/lit
- The License Installation Tool opens.
2. Click "Entered Manually".
- The "Add License Menu" opens.
3. Click the Product Name field to select the product.
- You can select:
4. Enter the number of licenses in the RTU field.5. Type the password for the licenses in the Password field.
- The password consists of 20 hexadecimal characters.
6. Verify that the password checksum number matches the information you have received from the license distribution center.
- If the checksum does not match, you must retype the password, the number of RTUs or the expiration date until the checksum is correct.
7. Verify that the data checksum number matches the information you have received from the license distribution center.
- If the data checksum numbers differ, you must contact the license distribution center to resolve the difference. These numbers must match.
8. Click Add.
- If you have additional licenses to install, repeat Step2 through Step5 for each feature and password.
9. Click Close when you have added the license for each feature.
- The license information appears in the Licenses To Be Installed field.
10. (Optional) Click Set Up Redundant Server Information.
- The Set Up Redundant Server Information menu opens. Use this menu to add the host name and host ID of two redundant servers, if you plan to use them.
11. Click Install.
- The License Installation Tool installs the licenses on your server and displays a message telling you that licenses are installed.
- When the licenses are installed, the license configuration script, LIC_CONFIG_SCRIPT, runs on the server where you run lit. If you have redundant license servers, a message appears identifying the servers on which you need to run the license configuration script.
12. Install licenses on the redundant servers.
- If you have redundant servers, perform the following steps.
- Copy file /etc/opt/licenses/LIC_CONFIG_SCRIPT from the license server where you ran lit to the remaining redundant license servers.
- Run the configuration script on each of the redundant servers. Type:
/etc/opt/licenses/LIC_CONFIG_SCRIPT
- This puts a copy of the license file on each of the redundant license servers in
/etc/opt/licenses/licenses_combined file.
- Look in log file /tmp/license_log for any errors.
5.5 Starting License Manager Daemons
The Solstice EM software uses two license manager daemons:
- lmgrd
- suntechd
Caution You should never start suntechd directly; lmgrd reads the license data file and starts all the daemons listed there.
If the license manager daemons are not running, you can start them by entering the lmgrd command. If you have multiple servers, you need to start the daemons on each server.
If the license manager daemons are running, you can update them by entering the lmreread command. This forces the license manager daemon (lmgrd)to reread the license data file and start any vendor daemons that have been added.
The administration commands are installed in the /opt/SUNWste/bin directory.
![]()
To Start the lmgrd Daemon
Under normal operations, you should not have to restart the lmgrd daemon. It restarts automatically when you install new license software and when the system reboots.
If the license daemon goes down, you need to restart it.
1. To find out if the license daemon is running, type the command:
- ps -ef | grep lmgrd
or
ps -ef | grep suntechd2. If lmgrd and suntechd are not running, start lmgrd by typing the command:
- /etc/rc2.d/S85lmgrd start
5.6 About License Data Files
A license data file contains information about the license server, the location of the license daemon, and the features being licensed. The example below shows an installation with one license server. There are five licensed features.
A license data file consists of four types of lines.
- Server line - A line beginning with SERVER followed by the server host name, server host ID, and, optionally, a TCP port number. If you request redundant servers, the data file will have three server lines, one for each redundant server.
- Daemon line - A line beginning with DAEMON, followed by the name of the daemon (always suntechd), the path name of the executable code of the daemon, and, optionally, the path name of an options file.
- Be sure the daemon path name is correct.
- Feature line - A line beginning with FEATURE or INCREMENT followed by the name of the feature being licensed, daemon name, feature version number, expiration date, number of licenses, password, and vendor string (currently null). There is one feature line for each feature being licensed.
- Comment line - A line beginning with a pound sign (#). There may be one or more comment lines in this file.
Most of the information in this file may not be altered. You should restrict access to this file so that users cannot accidentally alter it. You can alter only the following items:
- Host names--but not host IDs--on SERVER lines
- Port numbers on SERVER lines
- Path name of the daemon on DAEMON lines
- Path name of the options file on DAEMON lines
- Comment lines
5.7 Combining License Files
If you have other Sun products or products from another vendor that use FlexLM as their licensing mechanism, you may already have a FlexLM license server. This section describes how to administer licenses by combining license files, or by using the same server to administer multiple licenses.
You can combine license files into a single file if:
- Both files have the same number of SERVER lines.
- The hostid field of each server line in one file exactly matches the hostid field of each server line in the other file.
You cannot combine license files when the host IDs or number of servers are different as in the following situations:
- Different host IDs:
- The license files are set up to run on different servers.
- One vendor uses a custom hostid algorithm, so the host IDs on the SERVER lines are different, even though both files run on the same server.
- Different numbers of servers: One file is set up for a single server and the other is set up for multiple servers.
If any of the above is true, you should not combine files. You must keep the license files separate and run separate copies of lmgrd for each license file.
5.8 Adding New Products to an Existing License File
If you are adding another Solstice product to an existing file, add the new feature line after the existing feature line(s).
If you are combining products from different vendors, combine the license files and remove the extra SERVER lines so that only one set of SERVER lines remains.
5.9 Managing Licenses
The FlexLM licensing software includes administration tools that allow you to manage the licenses at your site. You can also create an options file that restricts and controls access to licenses.
5.9.1 License Administration Tools
The licensing package includes six administration tools:
- lmdown - Shuts down all license daemons. You must be root to run lmdown. This command should be run without the -q (quiet) option, thus forcing confirmation of the license server shutdown.
- lmhostid - Calls the FlexLM version of gethostid and displays the results.
- lmremove - Allows you to remove a single user's license for a specific feature. This is useful if, for example, a user's workstation crashes and a license becomes unusable. In that case, lmremove will free the license.
- lmreread - Causes the license daemon to reread the license data file and start any vendor daemons that have been added. All running daemons are signalled to reread the license data file so any new information is incorporated into their operation. Options files, however, are not reread. To reread the option files, you must restart lmgrd.
- lmstat - Displays the status of networking licensing activities.
- lmver - Displays the version of a library or binary file.
5.9.2 Setting Up an Options File
A default daemon_options file is installed as part of the licensing package in /etc/opt/licenses/daemon_options. You can modify this file before running the License Installation Tool. If the license daemon is running, you must stop it, modify the file, and then restart the daemon.
If you have multiple servers, be sure to make the same changes on all servers.
The options file allows you to control and manage the licensing mechanism. You can use the options file to:
- Allow or deny access to features by user
- Reserve licenses for specified users or hosts
- Define a linger time for idle licenses
- Define a time-out period for inactive licenses
- Control which license daemon messages are logged
The options file contains a number of lines starting with a keyword, with each line controlling one option. For example, the line EXCLUDE netfeature HOST mypc excludes host mypc from acquiring a license to use the feature netfeature.
5.9.2.1 Keywords
The keywords used in the options file are listed in the following table.
TABLE 5-1 Keywords Used in Options File LINGER Allows a host to keep a license for a set period of time after quitting the product INCLUDE Specifies a list of hosts allowed access to a feature EXCLUDE Specifies a list of hosts denied access to a feature INCLUDEALL Like INCLUDE, but applies to all features EXCLUDEALL Like EXCLUDE, but applies to all features TIMEOUT Sets a time after which an inactive license is reclaimed and can be used by a waiting user (default is 15 minutes) NOLOG Causes messages to be filtered out of the daemon's log output
5.9.2.2 Options File Format
The options file consists of lines in the following format.
LINGER feature value_in_seconds
INCLUDE feature HOST hostname
EXCLUDE feature HOST hostname
INCLUDEALL HOST hostname
EXCLUDEALL HOST hostname
TIMEOUT feature value_in_seconds
NOLOG {IN | OUT | DENIED | QUEUED}The notation HOST means you use the keyword HOST, followed by the name of a host.
The value given for TIMEOUT can be any positive number. However, the minimum value is 900 seconds (15 minutes).
Lines beginning with a pound sign (#) are considered comments and are ignored.
5.9.2.3 Allow or Deny Access to Features
Use the options file to specify a list of hosts that are allowed access to the licenses.
Use the INCLUDE line to indicate a list of hosts that are allowed access to the license. Any host not included in the INCLUDE statement will not be allowed to use that feature. For example, the line INCLUDE netfeature HOST mypc defines a host machine called mypc and allows it access to the feature netfeature. No other machine will be allowed access to this feature.
5.9.2.4 Define a Time-out Period for Inactive Licenses
You can specify the time, in seconds, after which an idle license will be freed and released to another user. You can specify this time in seconds, with a minimum number of 900 seconds (15 minutes). If you specify a time shorter than the minimum, the time-out will be set to 900 seconds.
5.9.2.5 Reserve Licenses
Use this option to reserve one or more licenses for a specific machine in the network. Reserved licenses are not available to other hosts. For example, the option line RESERVE 1 netfeature HOST pc-twenty reserves one license of feature netfeature for machine pc-twenty. Even when that host is not using the feature, the license will not be available to other machines on the network.
5.9.2.6 Control Information Logging
The option keyword, NOLOG, allows you to filter the types of messages that will be entered into the debug log file. The format for the NOLOG line is NOLOG status, where status can be one of the following:
- IN - licenses checked in
- OUT - licenses checked out
- DENIED - licenses denied
- QUEUED - queued requests
To turn off logging of checkins: NOLOG IN
To turn off logging of queued requests: NOLOG QUEUED
To turn off both checkins and queued requests requires two lines:
- NOLOG IN
NOLOG QUEUEDUse this option to limit the size of the debug log file.
5.10 Manual Pages
Helpful information in the form of manual (referred to as Man) pages for license administration tools are included in the licensing package and are installed in the directory /opt/SUNWste/man
To view these pages, set your MANPATH environment variable to point to the proper directory. For example, in a C shell, type the command:
set MANPATH /opt/SUNWste/manIn a Bourne shell, type the commands:
MANPATH=$MANPATH:/opt/SUNWste/manexport MANPATHTo set the path to the man pages permanently, add the /opt/SUNWste/man directory to the MANPATH environment variable in your shell startup file.
Sun Microsystems, Inc. Copyright information. All rights reserved. |
Doc Set | Contents | Previous | Next | Index |