|
|
This appendix describes how to obtain information on the licensing of Cisco Info Center components The licensing of components is controlled by a license server. For information on installing the license server software, see the Cisco Info Center Installation and Configuration manual.
This appendix contains the following sections:
The licensing of Cisco Info Center components is controlled by a license server. For information on installing the license server software, see the Cisco Info Center Installation and Configuration manual.
This appendix provides information on how to obtain information on licensing once the License Server software has been installed.
There are five commands that provide the following information:
These commands are located in the $OMNIHOME/bin directory.
The elmadmin command runs the license administrator program. Its functions include installing license keys, listing the users of licensed components, as well as other administrative functions.
| Option | Description |
|---|---|
-b cid | Buries the client by returning all licenses used by the client whose client ID is cid and marking this client as dead. You can display the client ID (CID) by entering elmadmin -l. A buried client can continue to run, but any function that communicates with the license server will return an error. |
-c | Installs a license key and prints a server code used to create a license key. A single application may have one or more keys. You can change the key directory using the -e option. |
-d | Sends a command to the license server that will send the contents of the license server database to the log file. This option is most commonly used for developer testing and debugging. |
-e keydir | Places the license keys in the The specified directory must already exist; it will not be created by the elmadmin command. |
-h | When used with the -l option, produces an expanded listing to include each client's hold time and the shared license count. The hold time is the duration that the licenses will be held for the user after the client exits. If the user starts the application again before the hold period ends, the held license is assigned to the user. The hold time amount is specified in the resource file. If the client is held, column one of the listing is flagged with an H. The shared license count is the number of clients that are currently sharing the license for the indicated feature. If the client has one or more shared licenses, column one of the listing is flagged with an S. |
-i | Prints the release number of the elmadmin command and the version of the License Manager Application Library with which it was compiled. |
-k | Kills the license server. |
-l | Lists the current users and outstanding licenses available for all features known to all license servers on the network. Known features are those features used since the license server was started, which is usually the last time the system was rebooted. If one or more features are on the command line, the listing contains the named feature(s) only. This option lists license packs individually. The -l option scans all license servers on the network. |
-p | Prevents ping. Use this option with the -c option. Using the -p option, the license server is not notified that a new key has been installed. This option is useful when you are installing a large number of keys at once. |
-q | Queries and prints environment information for debugging. The query output includes the current host name and its network address, the name of the slm_host environment variable and its current setting, the current port and license server name, the vendor ID, and the host code. |
-r n | Sets ready-key mode for use with the -c option. The n argument is the number of license servers that will be running (usually 1, unless redundant servers are being used). If n is positive, the command does not print the server code(s). Instead, it prompts for the server key and displays information associated with the key. If n is negative, the command does not prompt for the server key. Instead, it displays the specified number of server codes. |
-s | Finds all license servers using server address resolution and prints their names. If a feature name appears on the command line, the hosts responding with this feature are printed. |
-v n | Changes the license server log file verbosity level to n. You can use this option to change the level after the license server has started. |
-V C | Sets the encryption version to C, which must be a single upper-case character. |
-z | Zeroes out the log file. Clearing the log file by other means is ineffective because the license server keeps the log file open at all times. The next time the license server writes to the log file, it uses the old file pointer, filling the file to the original length. Thus you must use the -z option or the log file size option of elmd to clear the log file. |
The elmusage command prints a snapshot of current license activity to stdout. The snapshot is updated every ten seconds.
For each feature in use, a line is printed with the current number of licenses in use, the total number of licenses available, and the current occupancy percentage calculated as follows:
Occupancy = ((# of licenses in use)/(# of licenses available)) x 100
A high percentage indicates that more licenses are needed. If occupancy reaches 100%, a series of asterisks (*) are printed in the right column.
If the feature has a soft license count, that license count is printed under the total column and suffixed with S. If the license count is unlimited, unlim is printed and occupancy is always zero.
Table D-2 describes the syntax for the elmusage command.
| Option | Description |
|---|---|
-b numeric | Changes the interval to n seconds from the default value of 10. |
-i | Displays version information. |
The elmver command scans specified files for the license manager version information. For example, if you want version information for elmadmin, use the following command line in the commands directory:
The output will be similar to the following:
elmadmin.exe: SentinelLM License Manager release 5.0.1040
Files with version information are those that
The elmver command can be used for determining the release level of the License Manager library with which a command was compiled.
The elmrpt command produces a report of licenses available, or license activity from one or more license server log files. You must specify the log file name. The elmrpt command can display information in either numerical or histogram format.
 |
Note You may need to specify a log file that is not currently in use. |
The fields in a numeric report are as follows:
Table D-3 describes the syntax for the elmrpt command.
| Option | Description |
|---|---|
-d start_date [-end_date] | Limits reporting for dates between start_date and end_date inclusively. For example: elmrpt -d "95-Feb-3 - 95 Feb-10 12:30" logs.old elmrpt -d "95/3/15 - 95/4/15 5:00" logs.old You can specify the start_date and end_date dates in one of the following two formats: 95-Feb-3 12:30:00 95/2/3 12:30:00 Note that in either format, the days, hours, minutes, and seconds default to zero if the value is missing. If you omit the hyphen and end_date date, the report runs to the last available date in the log file. |
-f feature | Lists activity for a specified feature. Use multiple -f options to display activity for more than one feature. |
-h | Prints a usage histogram instead of numeric data. (See also -w). |
-i | Prints the release number of elmrpt and the version of the License Manager Library with which it is compiled, then exits. |
-l | Lists a summary of available licenses along with the number of tokens, the soft limit, the start date, the expiration date, and the key file name. No other options are valid with |
-m n[units] | Sets the minimum duration. Commands that execute for less than the time specified by n are ignored. You can specify the unit of time by following n with s (seconds), m (minutes), h (hours), d (days), or w (weeks). The default unit is seconds. By assigning a low value for n, such as 5 or 10 seconds, you can eliminate phantom statistics---those from commands that License Manager checks but fails to execute. You can also use this option to eliminate short application sessions from your statistics. For example, |
-t timeout | Displays total license activity for each timeunit, where timeunit is month, day, hour, minute, second. (A unique abbreviation, such as min, is accepted.) For example, elmrpt -d "95/3/15 - 95/4/15 5:30" -t hour If you omit the -t option, a total is printed. |
-u category | Prints a detailed report per user, as specified by category. The category can contain one or more qualifiers: |
-w n | Displays report with a width of n character units. The default is 78. This option is only valid with the -h option. |
The elmalert command notifies you when licenses become available or are close to expiration. The command checks the availability or expiration of licenses and either sends an e-mail or prints a message to the screen with the requested information.
You can use the elmalert command if the licensed application does not implement license queuing or if it is more convenient to receive notification this way. Users or system administrators can also use the command to track license expiration. For example, an administrator can request notification when licenses are within two weeks of expiration.
By default the License Manager sends a notification when each feature specified on the command line is available. To check license expiration, use the -x option. The options -m, -p, and -v control what, where, and how elmalert sends its information. You can use more than one of these options in the same command line. The default -p option is used if none of these three options is specified.
Table D-4 describes the syntax for the elmalert command.
| Option | Description |
|---|---|
-a | If multiple features are named on the command line, sends notification when all the licenses specified meet the requested condition. The notification notes licenses that are available or will expire in the number of days defined by the -x option. Without the -a option, notification occurs for each feature individually. |
-b n | Used with the -f option, checks every n seconds instead of the default 60 seconds. |
-e dir | Specifies a key directory other than the default. |
-f | Runs the command until the condition is met, instead of checking for the condition once and exiting. Using the -f option, once you are notified about a feature, the feature is removed from the checklist. When you have been notified of all feature licenses, the elmalert command exits. |
-h host | Specifies the host name that supports SMTP mail-forwarding. If unspecified, uses the current host. Use with -m option. |
-m | Sends mail to the user name used to invoke the command or to the name set using the -u option, if applied. This option works only on TCP/IP systems with an SMTP (Simple Mail Transfer Protocol) service (see option -h). |
-o n | Monitors occupancy. Sends notification if the number of licenses in use divided by the total number available reaches or exceeds n percent. For example, |
-p | Prints information to stdout when the license(s) become available or will soon expire. Also notifies by e-mail if you use the -m option. |
-u user | Sets the recipient to user for the e-mail (-m) option. |
-v | Sets verbose mode. Prints information about the status of the license(s). |
-x days | Prints notification if the feature will expire within the specified number of days. Also sends notification by e-mail if used with the -m option. |
Posted: Tue Jun 13 15:26:25 PDT 2000
Copyright 1989 - 2000©Cisco Systems Inc.