Realm Server Administration Utility Reference
Administrators use the realm server administration utility, tibrealmadmin, to stop, update, dump, or back up a realm server process.
Most command line parameters and options have both a short and a long form. The command line parser accepts either form. In addition, you can supply a Java-style properties form for most options in a configuration file (see --config).
Connecting to the Realm Server
| Parameter | Arguments | Description |
|---|---|---|
| --realmserver
-rs |
url | Required (except with the
--mangle command).
Administer the realm server at this location. url has the form http://host:port, where host and port correspond to elements of the realm server’s --http argument. |
| --user
-u |
username | Credentials. Required when the realm server enables user authentication (see
--auth.url).
The utility authenticates itself to the realm server with this username and password. |
| --password
-pw |
password | |
|
--tls.trust.file
-tf |
path | Optional. (Required for TLS communication with a secure realm server.)
Secure backup and satellite servers use this parameter to supply the file path to a local copy of the primary server's trust file. When both are present, this parameter overrides --tls.trust.everyone. For more information, see Running a Secure Backup or Satellite Realm Server. |
| --tls.trust.everyone
-te |
Optional.
The server trusts any realm server without verifying trust in the server's certificate. |
Commands
Commands are mutually exclusive. You may use only one at a time.
Most commands affect a realm server process that is already running. Specify that realm server using the --realmserver parameter.
Supply commands only on the command line. It is illegal to supply commands in a configuration file.
| Parameter | Arguments | Description |
|---|---|---|
| --dumprealm
-dr |
path | Write the realm definition to a JSON file at
path.
Modifiers: --debug |
| --updaterealm
-ur |
path | Update the realm definition from the JSON file at
path.
If a realm definition already exists, the utility replaces the old realm definition with the new definition. This command is available only for the primary server. Modifiers: --force |
| --backup_database
-b |
Immediately back up the realm server’s database files.
This command creates a zip file that contains the relevant files from the server’s data folder. The name of the zip file incorporates a timestamp. This command stores the zip file under the server’s data directory in the backups subdirectory (see --data). You may arrange to copy the contents of the backups subdirectory to off-site storage. |
|
| --status
-st |
Get the status of the realm server and its clients. Send output to stdout. | |
| --server_status | Get the status of the realm server, but omit the status of its clients. Send the status output to stdout. | |
| --shutdown
-x |
Stop the realm server process.
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. |
|
| --mangle | password | Obfuscate a password to hide it from casual observers.
You may supply the resulting obfuscated password as a command line argument to the realm server. For example, you may supply it to the --server.password parameter, or use it in the realm server's configuration properties file. This command outputs the obfuscated password to stdout, then exits immediately. (This command ignores the --realmserver parameter.) |
| --testupdate
-tu |
path | Test deployment using the realm definition in the file at
path. The realm definition file is in JSON format.
For information about the test, see The Deploy Transaction. |
Command Modifiers
| Long | Arguments | Description |
|---|---|---|
| --force | When present along with --updaterealm, break the realm lock, discarding any undeployed changes to the realm definition. | |
| --debug | When present along with --dumprealm, dump additional information for debugging. Use only when TIBCO support staff request this information. |
Configuration File
| Parameter | Arguments | Description |
|---|---|---|
|
--config
-c |
path | When present,
tibrealmadmin reads its configuration from the file at
path.
See Option and Property Names. If you specify both a configuration properties file and command line options, the command line options override those in the file (where they conflict). It is illegal to supply commands in a configuration file (see Commands). |