Server Configuration Upload/Download

When configured to use FTL stores, the EMS server will first connect to the FTL server cluster and fetch the configuration information before beginning its start-up sequence. The JSON configuration must be available in the FTL server cluster prior to starting the EMS server. If no configuration is available in the cluster, the EMS server will start-up with a default configuration.

The tibemsjson2ftl tool can be used to upload JSON configuration files to a specified FTL server cluster. It can also download JSON configuration files from a specified cluster.

Running the tibemsjson2ftl Tool

When the EMS server doesn’t find an EMS server configuration in the FTL server cluster, its subsequent behavior is dependent on whether the -config_wait parameter has been set in the FTL server cluster configuration. If present, the EMS server will halt its start-up process until the configuration becomes available. This provides the user with a chance to upload their own EMS server configuration to the cluster. If the parameter is not present, the server will simply start with a default configuration.

The tibemsjson2ftl tool can be used to upload JSON-based EMS configuration files to a specified FTL server cluster. It can also download JSON configuration files from a specified cluster.

The tibemsjson2ftl tool is invoked from the command-line. The tool is dependent on the FTL C client libraries, so the LD_LIBRARY_PATH environment variable must be set before running it.

export LD_LIBRARY_PATH=<FTL_HOME>/lib:$LD_LIBRARY_PATH
tibemsjson2ftl options

tibemsjson2ftl Options

The following table shows the options that are used with the tibemsjson2ftl tool.

Option Description
-url url

Required. The pipe-separated list of URLs of the FTL server cluster to connect to.

The URLs must be in one of these forms:

http://<host>:<port>
https://<host>:<port>
-json pathname

Required. The absolute path to the JSON configuration file to be uploaded to the FTL server cluster.

When the -download parameter is specified, the downloaded JSON configuration will be written to the value passed to this parameter.

-download When specified, tibemsjson2ftl will download the JSON configuration from the FTL server cluster and write it to the file passed to -json.

If this parameter is not specified, the tool will default to uploading the JSON configuration to the FTL server cluster.

-trust_all

Connect to the FTL server cluster without verifying the trust in the server certificate.

Do not use this parameter except for convenience in development and testing. It is not secure.

-trustfile path Path to the trust file for connecting to a TLS-secured FTL server cluster.
-user user

User name to use when authenticating with a secure FTL server cluster with basic authentication.
-password password

Password to use when authenticating with a secure FTL server cluster with basic authentication.

To hide the password from casual observers, see the Password Security section of the TIBCO FTL Administration guide for TIBCO FTL release 7.0.
-client_cert path Specifies the TLS certificate for authenticating with a secure FTL server cluster using mTLS.
-client_key path Specifies the private key corresponding to the TLS certificate in -client_cert to authenticate with a secure FTL server cluster using mTLS.
-client_key_password password

Specifies the password used to decrypt the private key when authenticating with a secure FTL server cluster using mTLS.

To hide the password from casual observers, see the Password Security section of the TIBCO FTL Administration product guide for TIBCO FTL release 7.0.
-oauth2_token token

The OAuth 2.0 access token to use when connecting to an FTL server cluster configured with OAuth 2.0 authentication.

Examples

 

Example 1

Uploading configuration to an FTL server cluster: 

tibemsjson2ftl -url http://hostname:8080 -json tibemsd.json

 

Example 2

Downloading configuration from an FTL server cluster: 

tibemsjson2ftl -url http://hostname:8080 -json tibemsd.json -download
Warning: When using EMS 10.4.1 and newer with FTL 7.1.0 and older on Linux, set LD_LIBRARY_PATH=FTL_HOME/lib and LD_PRELOAD=EMS_HOME/lib/libssl.so:EMS_HOME/lib/libcrypto.so prior to running tibemsjson2ftl. With FTL 7.1.1 and newer, doing this is unnecessary.