HOWTO Monitor SGD License Utilization

Introduction


Secure Global Desktop is licensed on a "per-concurrent-user, per-component" basis.  There are 5 components licensed in SGD:

Base Component
The ability to login, authenticate, etc.
Windows Connectivity
The ability to run Windows applications
Unix Connectivity
The ability to run Unix/Linux applications
AS/400 Connectivity
The ability to run 5250 applications
Mainframe Connectivity
The ability to run 3270 applications

When a user logs into SGD, the consume one Base Component license; when they run a Windows application, they consume a Windows Connectivity license, a Unix application, a Unix Connectivity license, and so on.  The will only consume a single license irrespective of the number applications they launch.

This describes how an administrator may monitor the license utilization across their array.  For a complete discussion on licensing, please refer to the SGD 4.40 Admin Guide - Licensing and SGD Software

Procedure

There are two mechanisms for monitoring SGD license utilization.

1.  The Tarantella License Command

 The "tarantella license" command displays license utilization information across the array, and has the following syntax:

tarantella license query  [ --now
                            --format text|csv|xml]
                            --maxusers [-format text|xml] ]



Option Description
--now Displays information on the current license usage across the array. This is the default if no arguments are specified
--history Displays recent historical information on license usage across the array.The license usage information is broken down by sample and software component. For each component, the command displays the following:
  • The number of licenses used.
  • The number of licenses available.
  • The maximum number of users using a component during the sample period (the peak).Use --format to specify the output format (by default, this is text).
--maxusers Use this option to display the number and the names of users who were consuming a license when license usage peaked in the history (30 samples) kept by SGD.A user consumes licenses if one of the following applies:
  • They are logged in to SGD.
  • They have a suspended application session.
  • They are within the lease period for a named-user license.Note - Anonymous or guest users are only listed once.The output distinguishes between standard and secure connections.
    Use --format to specify the output format (by default, this is text).

Examples

The following example displays information on the current license usage across the array.

$ tarantella license query --now
License usage at: Tue Feb 20 12:42:21 GMT 2007
Type                In use / Total
Base                9      / 100
UNIX                9      / 100
Mainframe           0      / 100
Windows             5      / 100
AS/400              0      / 100


The following example displays recent historical information on license usage across the array.

$ tarantella license query --history
2007/02/14 15:45:07:
 - Base       in use:     5 / 100         peak: 15
 - UNIX       in use:     5 / 100         peak: 15
 - Mainframe  in use:     0 / 100         peak: 0
 - Windows    in use:     3 / 100         peak: 12
 - AS/400     in use:     0 / 100         peak: 0
2007/02/15 13:25:53:
 - Base       in use:     9 / 100         peak: 16
 - UNIX       in use:     9 / 100         peak: 16
 - Mainframe  in use:     0 / 100         peak: 0
 - Windows    in use:     5 / 100         peak: 13
 - AS/400     in use:     0 / 100          peak: 0

The following example displays the numbers and names of users who were logged in when license usage last peaked.

$ tarantella license query --maxusers
Maximum number of users logged in: 3
o=Indigo Insurance/ou=IT/cn=Bill Orange
o=Indigo Insurance/ou=IT/cn=Ginger Butcher
o=Indigo Insurance/ou=IT/cn=Rusty Spanner


Source:  SGD 4.4 Reference Manual - License sub-command


2.  The "license" logfilter

A complete record of licensing-related events may be recorded using a logfilter for the component:

audit/licensing

This log filter will record all license related events on the array.  Note that this is not the recommended mechanism for monitoring license utilization, given the potentially large numbers of records it will generate.

This logfilter can be set using the administration console, such as:

 
 This will record all license-related events in the log files "license.log" (human-readable), and "license.jsl" (machine-readable, for use by the tarantella query command.) 

 Log filters may also be set by the "tarantella config edit" command, as documented in the SGD 4.40 Admin Guide - Using Log Filters

Examples

 The following shows the types of events recorded by the "audit/licensing/*" logfilter:

# more license.log
2008/07/15 11:15:31.424 (pid 13246)     audit/license/info      #1216134931422
Freeing base license. Total now in use: 0.

2008/07/15 11:15:45.945 (pid 13246)     audit/license/info      #1216134945945
Consuming base license. Total now in use: 1.

2008/07/15 11:17:02.903 (pid 13246)     audit/license/info      #1216135022903
Freeing base license. Total now in use: 0.

2008/07/15 11:17:34.419 (pid 13246)     audit/license/info      #1216135054419
Consuming base license. Total now in use: 1.

2008/07/15 11:19:28.187 (pid 13246)     audit/license/info      #1216135168187
Consuming windows license. Total now in use: 1.

2008/07/15 11:19:29.613 (pid 13246)     audit/license/info      #1216135169613
Consuming unix license. Total now in use: 1.

2008/07/15 11:20:15.556 (pid 13246)     audit/license/info      #1216135215556
Freeing windows license. Total now in use: 0.
 


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Sun Microsystems community and they might not be employed or in any way formally affiliated with Sun Microsystems. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Sun nor any other party necessarily agrees with them.

Copyright 1994-2009 Sun Microsystems, Inc.
Powered by Atlassian Confluence
Sun Guidelines on Public Discourse Privacy Policy Terms of Use Trademarks Site Map Employment Investor Relations Contact