Command syntax and parameters
You can use api.sh or api.bat to access a portion of the TADDM API functionality. The command syntaxes present the rules for running api.sh and api.bat.
For UNIX:
api.sh-u|--useruser-p|--passwordpassword [-H|--hosthost] [-P|--portport][-T|--truststorefile] COMMANDCOMMAND-PARAMETERSFor Windows:
api.bat-u|--useruser-p|--passwordpassword [-H|--hosthost] [-P|--portport][-T|--truststorefile] COMMANDCOMMAND-PARAMETERSCommon parameters
- -u|--user user
- The user that runs the API command.
- -p|--password password
- The password that authenticates the user.
- -H|--host host
- Optional: The TADDM server host name, by default, is
localhost. If you use the -T parameter, you must also specify the -H parameter. - -P|--port port
- Optional: The TADDM server port, by default, is
9433. - -v|--version version
- Optional: The version name or number, by default, is 0.
- -T|--truststorefile truststore
- Optional: Location of the truststore file, jssecacerts.cert, with a certificate for connection to the TADDM server. This parameter is required for secure connection to TADDM. If you use this parameter, you must also specify the -H parameter.
- COMMAND COMMAND-PARAMETERS
- The parameters are different for each of the commands.
Additional information
To see help about
the command and command-parameters, enter the following command from
the $COLLATION_HOME/sdk/bin directory:
- On UNIX systems
api.sh- On Windows systems
api.bat