z/OS Connect EE Plug-in for Zowe CLI
This plugin extends the Zowe CLI to allow the management of z/OS Connect EE APIs, Services and API Requesters.
The Zowe CLI needs to be installed.
Installing
zowe plugins install @zosconnect/zosconnect-zowe-cli@zowe-v1-lts
Create a profile
- Run the command
zowe profiles create zosconnect -a <server address> [-u <user id> -p <password> --ru]
Note: If you are using a self-signed certificate then --ru needs to be set to false.
Working with APIs
List the installed APIs
zowe zosconnect api list
Get information about an API
zowe zosconnect api info <API name>
Install a new API
zowe zosconnect api install <AAR file>
Update an API
zowe zosconnect api update <API name> <AAR file>
Delete an API
zowe zosconnect api delete <API name> [-f]
If you specify -f option then the CLI will stop the API before deleting it.
Start an API
zowe zosconnect api start <API name>
Stop an API
zowe zosconnect api stop <API name>
Working with Services
List the installed Services
zowe zosconnect service list
Get information about a Service
zowe zosconnect service info <Service name>
Install a new Service
zowe zosconnect service install <SAR file>
Update a Service
zowe zosconnect service update <Service name> <SAR file>
Delete a Service
zowe zosconnect service delete <Service name> [-f]
If you specify the -f option then the CLI will stop the Service before deleting it.
Start a Service
zowe zosconnect service start <Service name>
Stop a Service
zowe zosconnect service stop <Service name>
Working with API Requesters
List the install API Requesters
zowe zosconnect apirequester list
Get information about an API Requester
zowe zosconnect apirequester info <API Requester name>
Install a new API Requester
zowe zosconnect apirequester install <ARA file>
Update an API Requester
zowe zosconnect apirequester update <API Requester name> <ARA file>
Delete an API Requester
zowe zosconnect apirequester delete <API Requester name> [-f]
If you specify the -f option then the CLI will stop the API Requester before deleting it.
Start an API Requester
zowe zosconnect apirequester start <API Requester name>
Stop an API Requester
zowe zosconnect apirequester stop <API Requester name>
Support
If you experience any problems with this plug-in then please raise an issue and the development team will look into it.
Developing
- Clone this repository
git clone git@github.com:zosconnect/zowe-cli-zosconnect-plugin.git - Build the plugin
npm run build - Run the CLI Tests
npm test - Package the plugin
npm pack - Install the plugin
npm run pluginInstall - Run the integration tests
npm run integration