Running APIs in the QSHELL environment

All ARSxxxxxx API programs must be run using the QSHELL environment. QSHELL is a command interpreter that allows IBM® i to execute AIX® commands on IBM i. These commands can also be run from a script file. More information about QSHELL can be found in the IBM i online product information in IBM Documentation. Option 30 for 5770-SS1 (IBM i) installs the QSHELL intepreter. The QSHELL environment is started by the QSH or STRQSH IBM i command.

Multiple ARSxxxxxx programs may be issued in one QSHELL session. After the completion of a QSHELL command, a $ is displayed. This notifies the user that the QSHELL command has completed. This does not mean that the command actually ran successfully and performed the desired function.

All API examples that are provided assume that the QSHELL environment has been started. Content Manager OnDemand places a symbolic link to the commands in the /usr/bin directory during installation.

The -v parameter will provide detailed program logging information. The -u parameter specifies a valid Content Manager OnDemand user that exists with the proper authority to perform the functions requested. The -p parameter specifies the Content Manager OnDemand password for the Content Manager OnDemand user specified in the -u parameter, or the qualified stash file name that contains the password. The user ID and password are not normally needed when running these programs on IBM i. By default, the current IBM i user profile and password are used as the Content Manager OnDemand user ID. If your IBM i user profile does not exist in Content Manager OnDemand, you must specify a valid Content Manager OnDemand user ID and password or qualified stash file name to use these programs.

The -h is the Content Manager OnDemand instance name where the program is to execute. For the purposes of this document, the administrative user name will be testadmin, the password will be ondemand and the host name is QUSROND. User testadmin must have the appropriate authority to perform the function being requested by the ARSxxxxxx command.