5. The tc Server Command-Line Interface

This chapter documents tcsadmin, the tc Server command-line interface (CLI).

5.1 Overview of tcsadmin

The tcsadmin command-line interface (CLI) is the script version of the tc Server-related features of the HTML HQ user interface. Use tcsadmin to configure and manage both single and groups of tc Runtime instances.

[Note]Note

To use the CLI, you must install the HQ Server. When you run the various CLI commands, you specify an HQ Server by its hostname and port.

You can perform the following tasks with tcsadmin; all tasks are within the context of a particular HQ Server:

  • List the known tc Runtime instances, tc Runtime groups, and members of a group.

  • Create a group of tc Runtime instances.

  • List the applications deployed to a tc Runtime instance or tc Runtime group and the current status of the applications.

  • Upload and deploy an application to a tc Runtime instance or group.

  • Start, stop, reload, and undeploy an application to a tc Runtime instance or group.

  • Modify the configuration of a tc Runtime instance or group.

  • Upload a server.xml file to a tc Runtime instance or group.

  • Download the configuration of a tc Runtime instance or group and write it to a file.

  • Start, stop, or restart a tc Runtime instance or all members of a tc Runtime group.

In application management and configuration operations for a group of tc Runtime instances, the CLI performs the operations sequentially and synchronously. For example, if you deploy a Web application to a group of tc Runtime instances, the CLI deploys the application to one of the tc Runtime instances, waits for success, and only then deploys the application to another instance in the group.

Any user configured to access the HQ user interface can also use the tcsadmin CLI. Additionally, all role-based access is honored for all tc Runtime operations, including server configuration, application management, and server control.