This chapter introduces the Application Configuration Console Command Line Interface (CLI).
You can access the commands and data in Application Configuration Console through the graphical user interface in the Client or through the Command Line Interface. This reference document assumes you understand how to use the capabilities in the Client through the graphical user interface.
The command line interface (CLI) provides a low-level, programmatic interface to the same information that is managed through Clients. While you can perform many of the same operations in the CLI, the Client provides a richer command set and more visual feedback for the work you perform in Application Configuration Console.
Use the command line interface if:
You want to repeat specific steps on numerous occasions. You can script repeated operations with the command line interface and replay them as you need them.
You cannot access the Client.
You prefer using command line interfaces over graphical user interfaces.
We recommend that you use the graphical user interface to review the data hierarchy in Application Configuration Console before accessing the data from the command line interface. The CLI lets you navigate the resource hierarchy like a directory tree, but it's easier to visualize the tree after you've seen it presented graphically.
Note:A DOS window cannot handle non-ASCII characters. Therefore, to display multibyte characters properly, run the CLI from a console window within a Client that is UTF-8-enabled, not in standalone mode.
The CLI runs as a Python script that is installed in the eclipse directory where you installed the Application Configuration Console software. Use Python version 2.44, 2.54, or 2.61 to run the CLI.
The CLI requires JDK 1.6.x. If you have multiple versions of the JDK in your path and v1.6.x is not the first one, you must set the JDK_HOME property before starting the CLI.
Navigate to the following directory under the Client installation location, for example:
Open a text editor and create a new file that contains this line:
JDK_HOME=<your JDK1.6.x home>
Save the file as
cli.properties in the runtime directory.
You can start the CLI from a command prompt. When you start the CLI, you will be prompted for your Application Configuration Console username and password. You must include your domain name at the beginning of your username, as in
> startcli.py username: mydomain\myname password: password /Data =>>
=>> is the CLI prompt, which also shows you the current context. The default context when you start the CLI is
/Data. Within the CLI prompt, you can use the up and down arrow keys to cycle through all commands entered during a CLI session.
Note:You will not be able to start the CLI if there is a currently active Client session. There can be only a single CLI instance connected to the Core Server at any given time.