FTL Administration Utility

Administer the FTL server at this location.

Supply <url> in one of these forms:

http://<host>:<port> 
https://<host>:<port>

Credentials. Required when the FTL server enables user authentication.

Credentials. Required when the FTL server enables user authentication.

To see the ways to specify a password and to hide the password from casual observers, see Password Security.

The administration utility trusts an FTL server based on this trust file. Supply the file path of a local copy of the FTL server trust file.

When both are present, this parameter overrides the parameter:
--tls.trust.everyone.

Operates on one of the following:

• The realm configuration data belonging to the named FTL server

• The persistence data belonging to the named persistence service

Use in conjunction with the --name parameter (but not with the --ftlserver parameter).

Modifiers: --debug

If a realm definition already exists, the utility replaces the old realm definition with the new definition. This command is available only for a primary server.

After updating one primary FTL server, it automatically propagates the new realm definition to all other affiliated servers.

Modifiers: --force

For information about the test, seeThe Deploy Transaction

Backup the FTL realm configuration.

This command creates a backup of the current FTL realm configuration and associated state. A collection of files is written to the backups subdirectory of each FTL server's data directory.

The file names incorporate a timestamp. To restore the realm configuration data for a particular FTL server from backup, see --restore_realm.

Backup the persistence data for the given persistence cluster.

The persistence cluster must have disk persistence enabled.

The --cluster <string> modifier is required.

This command creates a backup of all persistence data, including message data and acknowledgments, for the given persistence cluster. The backup files are written to the backups directory of each persistence service in the cluster. The file names incorporate a timestamp.

By default, the backup directory for a persistence service is the same as the service's data directory. A different backup directory may be specified setting the savedir parameter for the persistence service in the FTL server YAML configuration file.

To restore the persistence data for a particular persistence service from backup, see --restore_backup.

Required modifier: --cluster <string>

Compact the persistence data for the given persistence cluster.

The persistence cluster must have disk persistence enabled.

The --cluster <string> modifier is required.

This command causes each persistence service in the given cluster to compact the service's disk persistence files. Active publishers and consumers are not interrupted, though some performance degradation is possible until the compaction completes.

See --compact_offline for compaction while the persistence service is not running and if online compaction is unwanted or impractical.

Modifier: --cluster <string>

This command is asynchronous, that is, the utility does not wait for confirmation that the server has stopped). To verify that the server has actually stopped, use the --status command.

Modifier: --savestate When present, the FTL Server saves the state to the disk before exiting.

This command is asynchronous, that is, the utility does not wait for confirmation that the servers have stopped). To verify that the servers have actually stopped, use the --status command.

Modifier: --savestate When present, the FTLServer saves the state to the disk before exiting.

Restore the realm configuration data and associated state of an FTL server (given by --name) from backup.

The --backupdir <path> modifier is required.

This command must be executed when the FTL server is not running.

This command selects the latest available realm configuration data (as determined by the timestamp in the file names) and copies it to the data directory (given by --datadir). There must not be any data files related to the given FTL server in the data directory.

Required modifier: --backupdir <path>

Restore the persistence data of a persistence service (given by --name) from backup. The --backupdir <path> modifier is required.

This command must be executed when the persistence service is not running.

This command selects the latest available persistence data (as determined by the timestamp in the file name) and copies it to the data directory (given by --datadir).

There must not be any data files related to the given persistence service in the data directory.

Required modifier: --backupdir <path>

Compact the disk persistence files of a persistence service (given by --name) in its data directory (given by --datadir).

This command must be executed when the persistence service is not running.

Offline compaction may be used when online compaction is unwanted or impractical. (See --compact_online for compaction while the persistence service is running.)

For argument <stdin>, accept input from standard input instead of a file.

Send the output of hash_all to a filename.

Use this parameter alone to perform password mask encoding explicitly. Mask strings begin with $mask$. For example:

$ tibftladmin --mask
************************************************************
TIBCO FTL FTLAdmin 6.10.0 V2
Copyright 2009-2023 Cloud Software Group, Inc.
All Rights Reserved. 

Use with --mask_file to direct output to a specified file. For example:

$ tibftladmin --mask_file inputfilename --mask_out outputfilename

When present along with -xc --shutdown_cluster or -x --shutdown, the FTL Server saves the state to the disk before exiting.