Secure Global Desktop Administration Guide > Commands > The tarantella license query command

The tarantella license query command

Syntax

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

Description

Displays information on license usage across the array, including license infringements.

To avoid inconsistencies arising from the replication of data across the array, you must run this command on the primary server in the array.

Note This command only shows the license usage for the software components that are licensed on a per-user basis.

Secure Global Desktop maintains a history of license usage for 30 samples. A sample is created every day, whenever the server is restarted (warm or cold), and whenever your license keys change (licenses added or removed).

Argument Description
--now Displays information on the current license usage across the array. This is the default if no arguments are specified.
--history [--format text | csv | xml] 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 number of licenses used;
  • the number of licenses available; and
  • the maximum number of users using a component during the sample period (the peak).

Use --format to specify the output format (by default, "text").

--maxusers [--format text | xml] Use this option to display the number and the full TFN names of users who were consuming a license when license usage peaked in the history (30 samples) kept by Secure Global Desktop.

A user consumes licenses if:

  • they are logged in to Secure Global Desktop; or
  • they have a suspended emulator session; or
  • they are within the lease period for a named-user license.

Note Anonymous or guest users will only be listed once.

The output distinguishes between standard and secure connections.

Use --format to specify the output format (by default, "text").

Information on recent license infringements is also shown whenever a Secure Global Desktop Administrator logs in to Secure Global Desktop.

Examples

$ tarantella license query --now
License usage at: Thu Nov 07 11:31:23 GMT 2002
Type                In use / Total
Base                6      / 10
UNIX                6      / 10
TSP                 6      / 10

Displays information on the current license usage across the array.

$ tarantella license query --history
2002/11/07 11:23:42:
 - Base       in use:     6 / 10         peak: 6
 - UNIX       in use:     6 / 10         peak: 6
 - Mainframe  in use:     0 / 0          peak: 0
 - Windows    in use:     0 / 0          peak: 0
 - AS/400     in use:     0 / 0          peak: 0
 - TSP        in use:     6 / 10         peak: 6
2002/11/07 11:25:39:
 - Base       in use:     4 / 10         peak: 6
 - UNIX       in use:     4 / 10         peak: 6
 - Mainframe  in use:     0 / 0          peak: 0
 - Windows    in use:     0 / 0          peak: 0
 - AS/400     in use:     0 / 0          peak: 0
 - TSP        in use:     4 / 10         peak: 6
 

Displays recent historical information on license usage across the array.

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

Displays the numbers and names of users who were logged in when license usage last peaked.

Related topics