The tarantella license query command

Syntax

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

Description

Displays information on license usage across the array, including license infringements. You must run this command on the primary server of the array.

Note This command only shows the license usage for license types that are enforced on a per-user basis.

Tarantella 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 license type. For each license type, the command displays:

  • the number of licenses used;
  • the number of licenses available; and
  • the maximum number of users using a license type during the sample period (the peak).

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

--maxusers [--format text | xml] This option is only available if your array uses concurrent user licensing.

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 Tarantella.

A user consumes licenses if:

  • they are logged in to Tarantella; 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").

--users [--format text | xml] This option is only available if your array uses named user licensing.

Use this option:

  • to list the users actively using licenses. The name displayed is the full TFN name of the user;
  • to list the types of license they are using; and
  • to see when a license lease expires.

A license "in use" means the user is actively using the license.

The lease expiry only displays when the user has stopped actively using the license.

Note Suspended sessions are counted as actively using a license.

Use tarantella license status to find out your lease period.

Information on recent license infringements is also shown whenever a Tarantella Administrator logs in to Tarantella.

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.

$ tarantella license query --users
.../_ens/o=Indigo Insurance/ou=IT/cn=Bill Orange:
 - Base: in use
 - UNIX: in use
 - TSP:  in use
.../_ens/o=Indigo Insurance/ou=IT/cn=Ginger Butcher:
 - Base: in use
 - UNIX: lease ends 2002/11/14 11:25:50
 - TSP:  in use
.../_ens/o=Indigo Insurance/ou=IT/cn=Rusty Spanner:
 - Base: lease ends 2002/11/13 11:31:50
 - UNIX: lease ends 2002/11/13 11:30:27
 - TSP:  lease ends 2002/11/13 11:31:50

Displays which named users are currently using licenses and when their lease expires.

Related topics
  • The tarantella license command
  • Licensing Tarantella
  • How Tarantella enforces licensing
  • Managing Tarantella license keys