Running IBM App Connect Enterprise commands on IBM z/OS Container Extensions (zCX) by using IBM z/OS console commands

Run IBM® App Connect Enterprise commands on IBM z/OS® Container Extensions (zCX) by using IBM z/OS console commands.

Before you begin

About this task

You can run IBM App Connect Enterprise commands (with the naming convention mqsi*) on IBM z/OS Container Extensions (zCX) by using IBM z/OS console commands. The IBM App Connect Enterprise command names are case-sensitive. The commands mqsiAssemblyInstall, mqsicommandconsole, mqsicredentials, and mqsivault are not supported on IBM z/OS Container Extensions (zCX).

Some commands, for example mqsideploy, require one or more input files to first be made available on the docker container that runs the integration server. If the files are not available on the integration server docker container, you must use the BIPXPUT sample JCL to transfer them.

Some commands produce output. You can copy or move files from the integration server docker container by using the BIPXGET sample JCL.

BIPXPUT and BIPXGET always overwrite a file that is already there and always transfer in BINARY mode. IBM z/OS Container Extensions (zCX) run in ASCII mode. You can convert a file from ASCII to EBCDIC in UNIX System Services by using iconv. For example, if you want to convert the ASCII file props.txt to EBCDIC, run the following command:
iconv -f ISO8859-1 -t IBM-1047 props.txt > props.ebcdic.txt

Procedure

  1. Optional: If your command requires one or more input files to be available on the docker container that runs the integration server, customize the JCL job BIPXPUT as advised in the job comments. For more information, see Customizing the JCL.
  2. Optional: If your command produces output, customize the JCL job BIPXGET as advised in the job comments. For more information, see Customizing the JCL.
  3. Optional: Submit the JCL job BIPXPUT.
  4. Run the IBM z/OS console command to run an IBM App Connect Enterprise command. Specify the name of your started task JCL, the name of the IBM App Connect Enterprise command that you want to run, and any parameters that are required.
    For example, if your started task is called BIPXCLIS, and you want to run the IBM App Connect Enterprise command mqsiexplain, with the parameter 3750, run the following command:
    /F BIPXCLIS,APPL='mqsiexplain 3750'

    Some commands require parameters to specify the work directory of an independent integration server. For example, mqsiwebuseradmin command - Windows, Linux, and AIX systems requires you to specify -w workDir, or --working-directory workDir, depending on whether you decide to use the short names or the alternative long names for the parameters. For these commands, you must specify /home/aceuser/ace-server for workDir.

    Some commands require parameters to specify the hostname or IP address of the computer on which the integration server is running, and the port on which the web user interface HTTP connection listener is listening. For example, mqsistartmsgflow command requires you to specify -i ipAddress, or --admin-host ipAddress, and -p port, or --admin-port port, depending on whether you decide to use the short names or the alternative long names for the parameters. For these commands, you must specify 0.0.0.0 for ipAddress. For -p or --admin-port, you must specify the value that you set for REST_PORT in your environment file ENVFILE.

    For more information about the commands that are available on IBM App Connect Enterprise, see Runtime commands.

  5. Submit the JCL job BIPXGET.

Results

The output of the command is written to ACECMDS in the job log.

What to do next

When you finish running commands, you can stop the integration server by using IBM z/OS console commands. For more information, see Stopping an integration server on IBM z/OS Container Extensions (zCX) by using IBM z/OS console commands.