The Zowe CLI is designed to allow you to work with mainframe resources remotely from a variety of tools such as IDEs, Terminals and build tools. It can also be extended by third parties to work with their products, and this is what we have done for z/OS Connect EE to aid with the the deployment and management of APIs, Services and API Requesters.


Zowe CLI needs to be installed following the instructions on the Zowe website. The z/OS Connect EE plugin is installed by running the following command:
zowe plugins install @zosconnect/zosconnect-zowe-cli

Configuring a connection

Connections to a z/OS Connect EE server are controlled through the use of profiles which are stored on the local machine. A profile for a z/OS Connect EE server can be created by running the command:

zowe profiles create zosconnect -a

If you have security turned on for the server then a user name and password can also be specified.

Working with APIs, Services and API Requesters

Each of the types of artefact has its own command group which allows you to list, create, update, delete, start and stop an API, Service or API Requester. Help about each command can be found by using the --help option and the full list of options is available here.

For example, to install a new API into the server run the command

zowe zosconnect api install path/to/file.aar

If you have any suggestions for what you would like the plug-in to be able to do or if you find any issues then please raise an issue against the GitHub repository.

4 comments on"Zowe CLI plug-in for z/OS Connect EE"

  1. Saikat Mukhopadhyay April 29, 2019

    Hello Sir,

    I have question. I am new in mainframe. I have downloaded zowe and installed zowe cli and configured UI. Started mainframe challenges part 1,2,3. My question is how I will connect TN3270 emulator using zowe cli through my mainframe id to complete rest challenges. Please suggest me. Thanks

    • Thiago Gomes Muntoreanu May 30, 2019

      Hello there,
      Firstly It os important to validade If you have zosmf installed into your environment. Zosmf is a pre requesit to you be able to intect with your Z System using Zowe . After validating that point and certify that Zowe CLI is locally installed into your compute, you need to define your zosmf profile which Will basically contains your mainframe credentials by using Zowe creste profile command line like below:

      Zowe profiles create zosmf-profile -H -P -u –pw . Hope that address your question

  2. Alex Dumitru May 24, 2019

    Hello Saikat,

    I am not sure I fully understand your situation without more details, but I am not sure that you can use the WebUI or CLI to complete the mainframe challenges (if we are talking here about Master the Mainframe contest). How did you install the WebUI ? If you have it locally, then it would not work as you would expect. It needs to be installed on mainframe, and I am not sure if those practice systems allows that (would be cool though). As with regards to the CLI, that indeed is a desktop application used to interact with your mainframe. There is no connection between the TN3270 emulator and the CLI, those are 2 different clients for mainframe interaction. If you have more questions about Zowe, I would encourage you to go to the slack channels and ask there. .
    Good luck with the contest.

  3. I would like to know how is the interaction between the Zowe CLI and the Zowe installed in the OMVS of z/OS, we are validating the option to deploy on Z through Zowe. Could you tell me a little more about this interaction. Thank you

Join The Discussion

Your email address will not be published. Required fields are marked *