TIBCO Spotfire® Server and Environment - Installation and Administration

config-userdir

Configures the user directory.

config-userdir 
[-c value | --configuration=value] 
[-b value | --bootstrap-config=value] 
[-m value | --mode=value] 
[-C <true|false> | --collapse-domains=<true|false>] 
[-S <true|false> | --safe-synchronization=<true|false>] 
[-s value | --domain-name-style=value] 
[-u <true|false> | --unsafe-domain-name-style-allowed=<true|false>]
[-n value | --site-name=value]

Overview

Use this command to configure the user directory.

Options

Option Optional or Required Default Value Description
-c value
--configuration=value
Optional configuration.xml The path to the server configuration file.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-m value
--mode=value
Optional database The name of the user directory mode to use. Supported values are database, ldap, and Windows. The current value will not be changed unless the argument is explicitly specified.
-C value
--collapse-domains=value
Optional false Indicates whether or not external domains should be collapsed into the internal SPOTFIRE domain, which is the domain used when running the user directory in database mode. The current value will not be changed unless the argument is explicitly specified.
CAUTION: When this feature is enabled, all users will belong to the same domain. If there are multiple users with the same account name from different external domains, they will now share a single Spotfire account. Because this could pose a security problem, this feature should be used with care.
-S <true|false>
--safe-synchronization=<true|false>
Optional false When this option is set to "true", the user directory will not disable users that it cannot find during LDAP or Windows NT synchronization. This flag has no effect if the user directory is running in Database mode. The current value will not be changed unless the argument is explicitly specified.
-s value
--domain-name-style=value
Optional dns The domain name style used by the server. Supported values are dns and netbios. The current value will not be changed unless the argument is explicitly specified.
-u <true|false>
--unsafe-domain-name-style-allowed=<true|false>
Optional false When this option is set to "true", the server will allow incompatible domain name style settings, instead of refusing to start. This option should be used with care; it can potentially lead to many users and groups being imported to the user directory with invalid domain names.
-n value
--site-name=value
Optional none The name of the site for which the configuration should be applied. This flag will only have effect when used in conjunction with the --mode flag.