BWAdmin

The BWAdmin provides a command-line console that can be used in local mode or enterprise mode to create and manage domains, AppSpaces, AppNodes, archives, and applications. Collectively, the entities provide the logical and physical structure for the runtime environment.

The BWAdmin provides the following features:

  • One tool for both local and enterprise mode with identical commands
  • Interactive shell
  • Batch/silent mode by passing a command file as an argument
  • Ability to run commands locally as well as remotely
  • Ability to address different BWAgent networks
  • Simple and intuitive command structures
  • Nested commands
  • Unix-style commands for complex scripting
  • Command completion

A full range of commands is available. Command can be run stand-alone from the command line or from the BWAdmin console. Unix-style scripts can be created to run BWAdmin commands. When scripting, you may need to include conditions for possible error codes.

For more information about error codes and the corrective action to take, see the TIBCO ActiveMatrix BusinessWorks™ Error Codes guide.

Commands can be issued from:

  • Interactive Mode: Useful for exploration. Commands are run from the BWAdmin shell. Any number of commands can be run in a sequence.
  • Command Line: Useful for execution of single commands. Commands are run stand-alone from the command line with the provided syntax.
  • Batch Mode: Useful for execution of repetitive commands.

To get help on a command, including syntax information, type help followed by the command name, from either interactive mode or the command line, for example: 

bwadmin help
bwadmin help create
bwadmin help registerteaagent

Interactive Mode

Interactive mode is used for exploring runtime entities. Enter interactive mode by typing bwadmin at the command line. To view a list of available commands, press tab.

The cd command sets the runtime entity context so you can omit runtime entity options for commands like create, delete, start, or stop.

Command Line

The BWAdmin commands can be issued from the command line in the format: bwadmin [options] command <arguments>

To see the list of all BWAdmin commands, type bwadmin help at the command line.

The following options can be specified for BWAdmin at the command line:

BWAdmin Command Options
Option Description Example
-b/--batch Reads a series of commands from the standard input. bwadmin --batch | bwadmin get admin.mode
-config Applies the configuration in the specified file to the server instance. bwadmin -config -d myDomain -a myAppSpace -cf file_path/config.ini
-D <property=value> Applies the specified value to the specified property. Use the BWAdmin get command to retrieve the value. bwadmin -D name=User1
-f <file[,<file>] Reads commands from the specified file or from the comma-separated list of files. The specified file can contain one command or multiple commands. Exits after command execution is completed. bwadmin -f backupMyAppNode.cmd
-l/--login <arg> Specifies the log in ID to use for the session. Given the following command: bwadmin -l User1

BWAdmin in interactive mode displays: 

bwadmin[User1]>
-logconfig <file> Uses the specified file for the Logback configuration. bwadmin -logconfig mylogback.xml

For more information about logging, see Logging.

-x,--xtrace Echoes the command to the terminal. Given the following command bwadmin -x create domain MyDomain1 the following sample output is issued: 
TIBCO ActiveMatrix BusinessWorks version 6.2.0, build V20, 2014-10-09
+ create domain MyDomain1
exit Exits the command-line console. bwadmin>exit exits the command-line console.

For more information about BWAdmin commands for different administration tasks, see the "BWAdmin Command Line" topics in the Administration Tasks and Reference section.

Batch Mode

A command file can be passed to BWAdmin at the command line with the -f option. The batch file should contain all required inputs. An example of a command file is a backup file created with the backup command.

The -f eoe command is an optional command and you can run the BWAdmin commands in a batch mode. If any of the commands fail, the subsequent commands are not run. Syntax for the command is bwadmin.exe -f eoe <command file>.

For example: bwadmin.exe -f eoe bwadmin.sh