Avantra Command Line Interface
How to use the Avantra Web Service by Command Line Executable
Avantra WebUI includes a command line executable called
avantra to access the web service and to read and write data. To get it, follow the procedure below:
Go to About, then press Download Avantra CLI Package.
A dialog will open and show a command-line example of how to display the help screen of the Avantra CLI. Press Download 'avantra.zip'.
avantra.zip. The package includes 3 files,
avantra.cfg, and either
avantra.baton Microsoft Windows operating systems or
avantraon Unix-like operating systems.
java, so you might need to add the full path if Java cannot be found in the path.
avantra.cfgis pre-configured and contains the complete URL of Avantra WebUI so you do not have to provide it on the command line. Call
avantrato get a usage overview of the command.
You can as well include options
password=to your config file so you don’t have to specify them on the command line.
Syntax of the Web Service Command Line Executable
The syntax is simple:
avantra [options] [command] [command options].
If you have specified the URL, user, and password options in the
avantra.cfg config file, the syntax is even more simple and just
avantra [command] [command options].
The examples below show the options:
- Display the usage
- Display help of a command
avantra help [command]
To show the complete syntax of the
avantra help ls
- Show list of servers
avantra ls servers
- Show a table of SAP systems of one customer only
avantra ls -l sapsystems@customer
- Turn off monitoring for 120 minutes of monitored object ‘mozart’
avantra moni-off -name mozart -duration 120