adapteradmin Command Modes

A full range of adapteradmin commands is available. A command can be executed stand-alone from the command line or from the adapteradmin console.

Commands can be executed in the following modes:

  • Interactive Mode: Useful for exploration. Commands are executed from the adapteradmin shell. Any number of commands can be executed in a sequence.
  • Command Line: Useful for execution of single commands. Commands are executed 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: 
adapteradmin help
adapteradmin help create
adapteradmin help registerteaagent

Interactive Mode

Interactive mode is used for exploring runtime entities. Enter interactive mode by typing adapteradmin 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

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

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

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

adapteradmin Command Options
Option Description Example
-b, -batch Reads a series of commands from the standard input. adapteradmin -batch | adapteradmin get admin.mode
-config Applies the configuration in the specified file to the server instance. adapteradmin -config -d myDomain -a myAppSpace -cf file_path/config.ini
-f <file>[,<file2>,...] 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. adapteradmin -f backupMyAppNode.cmd
-l, -login <arg> Specifies the login ID to use for the session. Given the following command: adapteradmin -l User1

adapteradmin in interactive mode displays: 

adapteradmin[User1]>
-logconfig <file> Uses the specified file for logback configuration. adapteradmin -logconfig mylogback.xml
-x, -xtrace Echoes the command to the terminal. Given the following command adapteradmin -x create domain MyDomain1 the following output is issued: 
TIBCO Adapeter Framework version 1.3.1, build V5, 2017-03-01
+ create domain MyDomain1

For information on adapteradmin commands, see Adapter Administration Command-Line Utility.

Batch Mode

A command file can be passed to adapteradmin 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 created with the backup command.