bootstrap
This command is used to bootstrap the server by creating a new bootstrap configuration file, and a corresponding server node in the database.
To update an existing file, use the update-bootstrap command.
bootstrap
[-f | --force]
[-n | --no-prompt]
[-o | --force-encryption-password]
[-c value | --driver-class=value]
[-d value | --database-url=value]
[-u value | --username=value]
[-p value | --password=value]
[-k value | --kerberos-login-context=value]
{-Ckey=value}
[-E <true|false> | --enable-config-tool=<true|false>]
[-t value | --tool-password=value]
[-e value | --encryption-password=value]
[-a value | --server-alias=value]
[-S value | --site-name=value]
{-Avalue}
[bootstrap configuration file]
[-i <true|false> | --use-only-ips=<true|false>]Overview
Use this command to create a new bootstrap configuration file.Options
| Option | Optional or Required | Default Value | Description |
|---|---|---|---|
|
Optional | none | Indicates that the tool should overwrite any existing bootstrap configuration file. |
|
Optional | none | Specifies that the tool should not prompt for missing password arguments. |
|
Optional | When this flag is specified, the operation will be performed even if the encryption password specified does not match the one currently in use.
CAUTION: This option should only be used to recover from a situation where the encryption password currently in use is lost and where there is no remaining
bootstrap.xml file containing it.
If a
bootstrap.xml file with the current encryption password does exist, use that file together with the
config-encryption command to change the encryption password before running this command.
|
|
|
Optional | tibcosoftwareinc.jdbc.oracle.OracleDriver | The name of the JDBC driver class. |
|
Optional | jdbc:tibcosoftwareinc:oracle://localhost:1521;SID=orcl | The JDBC URL to the database. Because this argument usually contains special characters, make sure to escape those characters or enclose the values between quotes. |
|
Optional | none | The database account user name. |
|
Optional | none | The database account password. |
|
Optional | none | If you use the Kerberos protocol to log in to the database, use this argument to specify the name of the JAAS application configuration to be used for acquiring the Kerberos TGT. This JAAS application configuration must be registered with Java using a
login.config.url parameter in the
<server installation dir>\jdk\conf\security\java.security (Windows) or
<server installation dir>/jdk/conf/security/java.security (Linux) file.
Note: 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, which prevents
Spotfire Server from using them for creating the initial connection to the database.
|
|
Optional | none | A JDBC connection property. Can be specified multiple times with different keys. |
|
Optional | true | If "true", the <config-tool> section should be created. Without this section, the configuration tool cannot be used on this computer. See
Bootstrap.xml file.
|
|
Optional | true | The configuration tool password used to decrypt the database password in the file bootstrap.xml. Can be specified only if a password is given and the argument --enable-config-tool is set to "true". |
|
Optional | none | The password for encrypting passwords that are stored in the database. If you do not set this option, a static password is used. Note that the same password must be configured for all servers in a cluster. |
|
Optional | The fully qualified host name as determined when this command is run, but it is only ever used as a unique identifier. | The server alias. Used for identifying the server, for example when specifying server-specific configuration. |
|
Required unless there is only one site available (in which case the server will be placed in that site). | Default | The name of the site to which the server should belong. The list-sites command can be used to find names of all available sites. New sites can be created using the create-site command. |
|
Optional | The host name(s) and IP address(es) as determined when this command is run. | The possible node backend addresses (host names and IP addresses). Used for internal communication within the Spotfire collective. The addresses will be used in the order they are provided (in cases where there is a need for ordering). This argument may be specified multiple times with different values. |
|
Optional | none | The path to the bootstrap configuration file to create. See Bootstrap.xml file. |
|
Optional | false | When this flag is specified, auto detection of hostnames and IP addresses will be limited to include only IP addresses. This argument and the
-Avalue argument are mutually exclusive, and IP addresses are detected automatically only if the
-Avalue argument is not used.
|
Examples
- To bootstrap the server to use an Oracle database with the bundled DataDirect JDBC driver:
config bootstrap --driver-class=tibcosoftwareinc.jdbc.oracle.OracleDriver --database-url="jdbc:tibcosoftwareinc:oracle://server:1521;SID=spotfire" --username=spotuser --password=spotuser - To bootstrap the server to use an Oracle database with the Oracle thin JDBC driver:
config bootstrap --driver-class=oracle.jdbc.OracleDriver --database-url="jdbc:oracle:thin:@server:1521:spotfire" --username=spotuser --password=spotuser - To bootstrap the server to use a Microsoft SQL Server database with the bundled DataDirect JDBC driver:
config bootstrap --driver-class=tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver --database-url="jdbc:tibcosoftwareinc:sqlserver://server:1433;DatabaseName=spotfire_server" --username=spotuser --password=spotuser - To bootstrap the server to use a Microsoft SQL Server database with the Microsoft JDBC driver:
config bootstrap --driver-class=com.microsoft.sqlserver.jdbc.SQLServerDriver --database-url="jdbc:sqlserver://server:1433;DatabaseName=spotfire_server" --username=spotuser --password=spotuser - To specify multiple back-end addresses for the server:
config bootstrap -Ahostname.example.com -Ahostname -Aip.x.y.z