|
If you enter true to enable TLS for ThingWorx or the Analytics Server APIs, several additional command parameters are required. For information about those parameters, see the relevant sections below.
|
|
For Analytics Server 9.2 and earlier, the TLS parameters must use SSL instead of TLS.
|
Launch Command Parameter | Description | ||
---|---|---|---|
--baseinstalldir | The path to the directory where the Analytics Server will be installed.
|
Launch Command Parameter | Description | ||
---|---|---|---|
--enable-components AnalyticsExtension | This parameter enables inclusion of Analytics Extension during the Analytics Server installation. If you do not want to install Analytics Extension when the installer runs, do not include this parameter in the launch command.
|
Launch Command Parameter | Description | ||||
---|---|---|---|---|---|
--TLS_FOR_ANALYTICS_APIS
| The default response is true. When TLS authentication support is enabled for the microservices, communication is protected between the ThingWorx Adapter and the Analytics APIs. Communication between the APIs is also secured.
| ||||
--ANALYTICS_SERVER_KEYSTORE_FILE_PATH | The location where the TLS Keystore file is stored. This file contains the signed TLS certificate. | ||||
--ANALYTICS_SERVER_KEYSTORE_PASSWORD | The password for the TLS Keystore. | ||||
--ANALYTICS_SERVER_CERTIFICATE_ALIAS_NAME | The alias name that is assigned to the signed TLS certificate. Alias names are converted automatically to all lower case. | ||||
--HOST_ADDRESS | IP address or fully qualified domain name of the primary network adapter on your ThingWorx Analytics Server. The value must match the SAN value provided on the TLS certificate. | ||||
--ANALYTICS_SERVER_TRUSTSTORE_PASSWORD |
A password that will be assigned to the Analytics Server truststore, a file where trusted TLS certificates are stored. This truststore is created automatically during Analytics Server installation | ||||
--JAVA_TRUSTSTORE_PASSWORD |
The password for the Java truststore, a file where trusted TLS certificates are stored. The truststore is created automatically, with a default password, when Java is installed. For more information about Java Truststore passwords, see Working with Certificates and SSL on the Oracle website. |
Launch Command Parameter | Description | ||||
---|---|---|---|---|---|
--ENABLE_ZOOKEEPER_TLS
| The default response is true. When TLS authentication support is enabled, the ZooKeeper connections with the Async Microservice and the Analytics Common Workers are protected.
| ||||
--ZOOKEEPER_KEYSTORE_FILE_PATH | Path to the TLS Keystore file where the signed ZooKeeper TLS certificate is stored.
| ||||
--ZOOKEEPER_KEYSTORE_PASSWORD | Password for the TLS Keystore. | ||||
-ZOOKEEPER_TRUSTSTORE_FILE_PATH | Path to a JKS Truststore file that contains the authority that signed the ZooKeeper certificate.
| ||||
-ZOOKEEPER_TRUSTSTORE_PASSWORD | Password for the TLS Truststore.. For more information about Java Truststore passwords, see Working with Certificates and SSL on the Oracle website. |
Launch Command Parameter | Description | ||||
---|---|---|---|---|---|
--THINGWORX_FOUNDATION_IP_ADDR | IP address or host name of your ThingWorx server, which must already be installed and running. If you are using TLS for your connection to ThingWorx, this IP Address or Host Name must match the SAN address or host used to create the ThingWorx TLS certificate.
| ||||
--THINGWORX_FOUNDATION_PORT | The port for communicating with your ThingWorx server. If you are using TLS for your connection to ThingWorx, enter that port number. | ||||
--THINGWORX_APPKEY | The value from the Key ID field of the application key you created in ThingWorx. | ||||
--ANALYTICS_SERVER_THINGNAME | A name for the AnalyticsServer Thing that is created in ThingWorx during the Analytics Server installation. This full name is attached as a prefix to each microservice name. This Thing name must be unique within the server deployment.
| ||||
--AUTO_CONFIG_ALERT_SUBSYSTEM | Set to true if you plan to use Anomaly Detection functionality with this installation of Analytics Server. When this option is enabled, the installer automatically configures the Alert Processing Subsystem in ThingWorx. | ||||
--TLS_FOR_THINGWORX_CONNECTION
| Set to true in order to require the use of TLS when connecting to ThingWorx. The default value is false.
| ||||
TLS parameters for 9.2 and later | • --UPLOAD_TWX_CERTIFICATE – Set to true if you want the installer to upload your ThingWorx TLS certificate automatically. The default value is false For a new installation using TLS, this option must be enabled. For an upgrade, modify, or repair installation, this option is necessary only if you want to upload a new certificate. To continue using an existing certificate, use the default value (false). For more information, see TLS Support for ThingWorx. • --THINGWORX_CERTIFICATE_FILE_PATH – The location where the ThingWorx TLS certificate file is stored. This file is either a PEM or CER file. This parameter is required when --UPLOAD_TWX_CERTIFICATE is set to true. • --THINGWORX_TRUST_STORE_PASSWORD – Password that will be assigned to the ThingWorx truststore, a file where trusted TLS certificates are stored. This truststore is created automatically during Analytics Server installation. | ||||
TLS parameters for 9.0 and 9.1 | • --UPLOAD_TWX_CERTIFICATE – Set to true if you are using a self-signed ThingWorx TLS certificate and you want to allow the installer to upload it automatically. The default value is false, but you will need to import the certificate manually if it is not uploaded by the installer. For more information, see Import a Self-signed TLS Certificate Manually. • --THINGWORX_CERTIFICATE_FILE_PATH – The location where the ThingWorx TLS certificate file is stored. This file is either a PEM or CER file. This parameter can be omitted if you are not using a self-signed TLS certificate that you want the installer to upload. • --THINGWORX_CERTIFICATE_ALIAS_NAME – An alias name that is assigned to the TLS certificate. Alias names are converted automatically to all lower case. • --JAVA_TRUSTSTORE_PASSWORD_T – The password for the Java truststore, a file where trusted TLS certificates are stored. The truststore is created automatically, with a default password, when Java is installed. For more information about Java truststore passwords, see Working with Certificates and SSL on the Oracle website. |
An advanced option is available if you want to override the default user account during the installation. For more information about launching the installer with this option, see Change the User Account. |
Component | Component Name | Description | ||
---|---|---|---|---|
Async Microservice | async | Disables the Async Microservice along with other necessary components, including ZooKeeper and Analytics Common Workers.
| ||
Sync Microservice | sync | Disables only the Sync Microservice. | ||
Integration with ThingWorx | ThingWorx_Integration | This parameter must not be disabled if you plan to interact with ThingWorx Analytics via ThingWorx. |
You still need the twas-twx-adapter to be installed if you plan to integrate with ThingWorx. |
The Analytics Extension installation is not complete until you perform the necessary post-installation configuration steps. For information about these steps, see Perform Post Installation Configuration for Analytics Builder or for Analytics Manager. |