Command Line Interface

The Automation Analytics & Intelligence (AAI) command line interface (CLI) is an alternative way to access the AAI Server. It allows a user to collect commands into a script for repeated or automated execution, and provides a way to access the AAI server without logging in to the GUI client. Only a subset of AAI functionality is currently exposed through this interface. This following sections describe how to run the included scripts and how to write new scripts.

Important prerequisite!

Please note that, because the AAI CLI uses Python to create the calls from the CLI commands, Python must be installed on the server that you make the calls and posts from. This should be the latest version of Python or at least the version listed in the Compatibility Matrix for this version of version of AAI > AAI Server.

Example scripts are provided

To help you create scripts that include the CLI commands, you can find sample jython scripts in the <AAI_Installation>/examples directory. Copy these examples as a starting point or template for defining your own scripts with your own parameter values.

Important !

Do not modify the scripts in the examples directory. Instead, make a copy with another name because example scripts with the original names will be overwritten when you upgrade your installation.

Additional CLI for System Configurations

Although you define system configurations in the AAI Configuration Tool, there are a few configurations that you can alternatively define using the Configuration Tool CLI. For information, see Configuration Tool Command Line Interface. Also see Using the AAI Configuration Tool.

This section includes the following pages: