show-licenses

Shows licenses set on the server.

show-licenses 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
[-l value | --license=value] 
[-x <true|false> | --expand-groups=<true|false>]
[-p value | --path-to-report=value]
[-f <true|false> | --force-overwrite=<true|false>]

Overview

Use this command to create a report file that shows the licenses set on the server.

You can read the resulting file in Spotfire. The file has headers that explain the contents displayed in the columns. The column "From Group" contains the group on which the license is explicitly set. For every group that has a license set explicitly, the resulting groups and users (if the expand option is set) are shown once.

Users get the sum of all licenses (and functions). When you analyze the file, note that a user and a license might occur more than once if the user gets its licenses from more than one group with explicit licenses set.

This command may take some time to run. Also, you may need to increase the Java memory allocation to run the command, especially if the users are displayed.

Options

Option Optional or Required Default Value Description
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. See Bootstrap.xml file help topic for more information.
-l value
--license=value
Optional none An optional, comma-separated list of licenses. If provided, the report contains only these licenses. If an invalid entry is given, the valid licenses are displayed.
-x <true|false>
--expand-groups=<true|false>
Optional false Specifies whether groups are expanded to show their members.

Members of the Administrator and Library Administrator group can see all content.

When expand-groups is "true", these implicit rights are also taken into account, and these groups and their members are also displayed.

-p value
--path-to_report=value
Optional none The name of the report file that should be generated. If not provided, an automatic name is generated.
-f <true|false>
--force-overwrite=<true|false>
Optional false If a name for the report file is provided but a file with that name already exists, set this option to "true" to overwrite the existing file.