Shell Commands

Shell commands are quite similar to the bash commands in Unix. Almost all tasks performed on the Web UI can be performed using Shell commands. The shell provides a rich set of navigation, scripting, and help commands.

The default idle timeout for the shell is 15000 milliseconds.
Note: If you are using IPv6 addresses, assuming that the IP address of the machine is 10::4, the syntax of ssh command to be used is: 
'ssh -p 2222 admin@10::4
Remember that with IPv6 addresses, ssh -p 2222 admin@[10::4] is not supported.

When working with the Shell commands, after executing a command, an exit code is propagated from the TIBCO Enterprise Administrator server to the agent. When an exception occurs while evaluating a shell command, it results in a non-zero exit code returned by the ssh. You can also create your own exit codes. If an agent throws an exception, you can explicitly set an exit code on the exception.

Caution: Avoid registering two agents with the same ID. The TIBCO Enterprise Administrator server does not validate whether two agents have registered with the same ID.
  • Help Command
    To get comprehensive help using a command, use the --help option with the command.
  • Navigation Commands
    Navigating the object hierarchy on the TIBCO Enterprise Administrator server is quite similar to navigating a file system. Commands offered are similar to the basic navigation commands available in Unix. Each object has a path corresponding to it.
  • Scripting Commands
    You can use advanced scripting constructs to combine multiple commands and write complex scripts.
  • Interactive Mode
    When using the command-line interface, you can use the Shell commands in an interactive mode . The interactive mode gives you immediate feedback on every statement.
  • Advanced Scripting Commands
    In addition to the basic scripting commands, the Shell command language supports some advanced constructs that help in scripting. Use these constructs to write complex scripts.
  • Direct Commands
    The TIBCO Enterprise Administrator shell supports executing commands directly from the input.
  • The Script File Command
    A script file is equivalent to a batch file where you can list all the commands you want to execute sequentially.
  • The Protocol Commands: SFTP and SCP
    TIBCO Enterprise Administrator server supports the SSH File Transfer Protocol (SFTP) and Secure Copy Protocol (SCP) commands.
  • Using Position and Named Arguments while Defining TeaParam
    The definition of TeaParam provides four options when it comes to supporting positions and named arguments: position only, position and named arguments without an alias, position and named arguments with an alias, and named argument only.