show-library-permissions

Shows permissions set in the library.

show-library-permissions 
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value] 
<-l value | --library-path=value> 
[-r <true|false> | --recursive=<true|false>] 
[-x <true|false> | --expand-groups=<true|false>]
[-d <true|false> | --downward=<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 permissions in the library.

Permissions are set on directories. if no permission is set, the directory inherits the permissions from the directory above.

You can use this command in three different ways:
  • It can show if any permissions are set explicitly on a directory.
  • It can show what permissions are in effect on a certain directory. If no permissions are set on the directory itself, it will continue upwards until it finds the directory from which the permissions are inherited (see recursive option).
  • It can be used to report on all directories with permissions explicitly set in a branch of the directory (see the downward option).

The resulting file should be possible to read in Spotfire. It has headers that explain the display in the different columns.

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 bootstrap.xml file. If the tool password is omitted, the command will prompt the end-user for it on the console. See Bootstrap.xml file help topic for more information.
-l value
--library-path=value
Required none The path in the library to start to report with (must start with a /).
-r <true|false>
--recursive=<true|false>
Optional false If no permission is set on this directory, continue upwards until permissions are found.
-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.

-d <true|false>
--downward=<true|false>
Optional false Lists permissions on an entire branch of the library, and shows only folders where permissions are set explicitly. (This option takes precedence over the recursive option.)
-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.