update-bootstrap

Updates an existing bootstrap configuration file.

update-bootstrap 
[-c value | --driver-class=value] 
[-d value | --database-url=value] 
[-u value | --username=value] 
[-p value | --password=value] 
[--clear-username-and-password] 
[-k value | --kerberos-login-context=value] 
[--clear-kerberos-login-context] 
{-Ckey=value} 
[--clear-connection-properties] 
[--disable-config-tool] 
[--enable-config-tool] 
[-t value | --tool-password=value] 
[-a value | --server-alias=value] 
[-r | --prompt] 
[bootstrap configuration file]

Overview

Use this command to update an existing bootstrap configuration file. To create a new file, use the bootstrap command. Server addresses can be set using the set-addresses command. The encryption password can be updated by using the config-encryption command. The site to which the server belongs can be changed by using the set-site command.

Options

Option Optional or Required Default Value Description
-c value
--driver-class=value
Optional none This argument specifies the name of the JDBC driver class. If not specified, the previous value is kept. Note that if you change driver you will likely also have to modify the URL (using the --database-url argument).
-d value
--database-url=value
Optional none This argument specifies the JDBC URL to the database. If not specified, the previous value is kept. Because this argument usually contains special characters, make sure to escape those characters or enclose the values between quotes.
-u value 
--username=value
Optional none This argument specifies the database account's username. If not specified, the previous value (if any) is kept.
-p value
--password=value
Optional none This argument specifies the database account's password. If not specified, the previous value (if any) is kept. Use the --prompt flag to indicate that the tool should prompt for the password.
--clear-username-and-password
Optional none When this flag is specified, any existing username and password will be removed. Use this to switch from username/password-based authentication to Kerberos or NTLM. Cannot be specified together with the --username, --password, or --tool-password arguments.
-k value
--kerberos-login-context=value
Optional none This argument specifies the name of the JAAS application configuration to be used for acquiring the Kerberos TGT, when using the Kerberos protocol to log in to the database. If not specified, the previous value (if any) is kept unless the --clear-kerberos-login-context flag is specified. The JAAS application configuration must be registered with the JVM using a login.config.url parameter in the <server install directory>\jdk\jre\\lib\\security\java.security file (Windows) or <server install directory>/jdk/jre/lib/security/java.security file (Unix).

The Spotfire Server import-jaas-config command cannot be used for this purpose because the JAAS application configurations that are imported using this command are stored in the database itself, which prevents the Spotfire Server from using them for creating the initial connection to the database.

--clear-kerberos-login-context
Optional none When this flag is specified, any previous Kerberos login context will be cleared. Cannot be specified together with the --kerberos-login-context argument.
-Ckey=value
Optional none A JDBC connection property. Several properties may be specified. If not specified, the previous values (if any) are kept unless the --clear-connection-properties flag is specified. This argument may be specified multiple times with different keys.
--clear-connection-properties
Optional none When this flag is specified, any previous connection properties will be cleared. Cannot be specified together with the -C argument.
--disable-config-tool
Optional none When this flag is specified the config-tool section (if any) will be removed from the bootstrap configuration file. Disables the use of the configuration tool with this bootstrap configuration file. Cannot be specified together with the --enable-config-tool argument. If neither the --disable-config-tool nor the --enable-config-tool argument is specified, the capability will remain as before.
--enable-config-tool
Optional none When this flag is specified, a config-tool section will be added to the bootstrap configuration file. Enables the use of the configuration tool with this bootstrap configuration file. Cannot be specified together with the --disable-config-tool argument. If neither the --disable-config-tool nor the --enable-config-tool argument is specified, the capability will remain as before.
-t value
--tool-password=value
Optional none This argument specifies the password needed to execute most configuration tool commands. If not specified, the previous value (if any) is kept. Use the --prompt flag to indicate that the tool should prompt for the password.
-a value
--server-alias=value
Optional none The server alias. Used for identifying the server, for example when specifying server-specific configuration. If not specified, the previous value is kept.
-r
--prompt
Optional none When this flag is specified, the tool will prompt for any missing password arguments.
bootstrap configuration file
Optional none This argument specifies the path to the bootstrap configuration file to create. See Bootstrap.xml file for more information about this file.