Admin Command Line Interface for ARA Server

All system configuration tasks are executed via a windows command line interface (admin-cli.exe). 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.

You can find the CLI in your installation package (see Installation).

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:

Parameter	Explanation
`-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 ARA server.
`-usr`	ARA user
`-pwd`	Password

Return codes:

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

Code	Shortname	Description
0	Success	The operation was completed successfully
1	Invalid Options	Invalid options or an invalid combination of options were provided to the function. The error message provides more details.
2	Invalid XML	The input xml is not well formed (no valid XML)
3	Connection Error	No connection could be established to the Server
4	Authentication Error	The user could not be authenticated
5	Authorization Error	The user does not have the required permissions
6	Schema Validation Error	The input XML does not validate with the required schema
7	Timeout	No response was received from the server within 30 seconds
8	Business Rule Violation	The operation executed by the API based on an input XML was not valid because a business rule was not matched. E.g. the max number of characters of a type name was exceeded.
9	File not found	The given input file was not found.
>19		Command specific errors

Open topic with navigation