Admin Command-Line Interface for CDA Server

All system configuration tasks are executed via a windows command-line interface (admin-cli.exe). Path: Automic\Release.Manager\Utilities\AdminCLI. The program does not connect to the product database directly, but communicates with a web service on the application server that executes the logic. No other files are required to run the CLI. Administrators can easily distribute it to all machines where administrative access is required.

Topics:

General Information

You are prompted for the connection URL, the user name, and the password to establish a stateful session with the server (like a plsql prompt). In the prompt, you can call all functions without having to pass the -con, -usr, and -pwd parameters.

The CLI is stored in the Utilities Folder (Automic\Release.Manager\Utilities\AdminCLI) of your installation package.

Note: If not present: download/unpack and copy the utilities to your utilities folder (for example: c:\Automic\Utilities\)

Important! Errors are written to the log file.

Terminology

• The command line is accessible via the admin-cli.exe console application
• [...] indicates optional parameters
• Alternatives are indicated with (...|...|...).
• The order in which parameters are provided does not matter

admin-cli.exe delete -mt "DeploymentTarget" -ct "MyCustomType" -con http://theARAServer/ara -usr 100/ARAADMIN/AUTOMIC -pwd xxx

Global parameters

• -fi file

  The filepath to the input XML that is expected by most commands. If missing, the input stream is used.

• -con

  Connection to the CDA server

• -usr

  CDA user

• -pwd

  Password

Return codes

Each call to the CLI returns with one of the following codes.

• 0

  The operation was completed successfully

  Shortname: Success

• 1

  Invalid options or an invalid combination of options were provided to the function. The error message provides more details.

  Shortname: Invalid Options

• 2

  The input XML contains invalid format (no valid XML)

  Shortname: Invalid XML

• 3

  No connection could be established to the Server

  Shortname: Connection Error

• 4

  The user could not be authenticated

  Shortname: Authentication Error

• 5

  The user does not have the required permissions

  Shortname: Authorization Error

• 6

  The input XML does not validate with the required schema

  Shortname: Schema Validation Error

• 7

  No response was received from the server within 30 seconds

  Shortname: Timeout

• 8

  The operation executed by the API based on an input XML was not valid because a business rule was not matched. For example, the max number of characters of a type name was exceeded.

  Shortname: Business Rule Violation

• 9

  The given input file was not found.

  Shortname: File not found

• >19

  Command specific errors