ChangeMan ZMF Plug-in for ZOWE CLI lets you interact with ChangeMan ZMF systems on the mainframe in a familiar zowe command line format. If you are already familiar with the Zowe CLI, you will find the ZMF Plugin-in very familiar to work with.
ZMF CLI commands can be entered and executed in a script written in Python (for example) to perform a variety of downstream business functions.
Before installing the ChangeMan ZMF Plug-in for Zowe CLI, the following pre-requisites are necessary to be installed.
Download the ChangeMan ZMF Plug-in for Zowe CLI and save the .tgz file to a local directory of your choice. From that local directory, install the plugin using the zowe plugins l command. where n.n.n is the version of the .tgz file downloaded.
zowe plugins install microfocus-zmf-cli-plugin-n.n.n.tgz
The plugin will be installed. All ZMF Plugin commands use changeman-zmf as the top level group name - or the abbreviation of zmf and can be tested by issuing the following command to display ZMF CLI help
zowe zmf -h
This command will then display the next level of available ZMF command. this level always presents a verb - get, checkin, checkout etc. As with Zowe CLI, each level of subcommand has the available help option by appending the parameter. Example: zowe zmf get -h
As there are a number of ZMF cli commands available, To help in identifying the required parameters for each command,, you can generate web help by issuing the command:
zowe --hw This will generate all the help files and display in a browser. The location of the web help will depend on your platform. As new versions of the ChangeMan ZMF Plug-in CLI are released, you should regenerate the web help to pick up new documented features. See screenshot for sample web help.
Please refer to the REST Services Getting Started Guide and the browser based REST prototyping tool for details on the REST services. as the ZMF CLI uses the exact parameter format as defined in that Guide. Also refer to the ZMF XML Services Guide for more information on individual parameters.
Before attempting to use the ChangeMan ZMF plug-in for Zowe CLI, it is necessary to create a profile for each ZMF subsystem that you wish to execute ZMV CLI commands against.
Profile creation is a standard zowe cli function and details can be found here: Using Zowe CLI | Zowe Docs.
For example to create a profile with the name U830ALL using the host zos123 with secure SSL port 1234 and a basepath URI of /zmfrest, userid of ibmuser and password myp4ss and setting rejectunauthorised to false
zowe profiles create zmf-profile U830ALL -H zos123 -P 1234 --pr https --bp /zmfrest -u ibmuser --pass myp4ss --ru false
You may specify a protocol of either http or https but ensure that the port number that you specified is correct for that protocol. Note that using an HTTPS port will require require that you have AT-TLS set up and configured on your mainframe host. Refer to the IBM AT-TLS documentation on configuring AT-TLS for your specific environment. In particular ensure the ciphers are defined correctly.
Also zowe provides a very good write up on how to configure AT-TLS for an SSL environment. Configuring Zowe Application Framework | Zowe Docs
An example ZMF CLI command :
zowe zmf get cbp -c CBLDB201 -T SRC -P STEV001571
cbp = Component Browse Package - the related REST service using the prototyping tool is /component/browsepackage
-c = Component
-t = Component Type
-p = Package
Alternatively, you my use the long form of the command:
zowe changemanzmf get component-browsepackage --component CBLDB201 --componenttype SRC --package STEV001571
Note that the fields are case sensitive.
The ZMF cli plug-in returns output to the screen. This will either be a string -.e..g. a source component, or a JSON object. Typically, using a script, the output would be piped to a local file and post processed.
A simple example python script screen shot can be seen above, which demonstrates retrieving a component and its associated copybooks and saves them to a local directory. Post processing of those files can then take place outside of ZMF.
Support for the ChangeMan ZMF Plug-in for Zowe CLI is available on the Micro Focus Community page for ChangeMan ZMF.
Please do not go through the normal Support channels for this component.
Suggested for you are based on app category, product compatibility, popularity, rating and newness. Some apps may not show based on entitlements. Learn more about entitlements.
ChangeMan ZMF Plug-in for Zowe CLI
Added support for a single persistent session to be established. This is achieved by issuing:
- zowe zmf session zl command. This will return a 200 if successful and a token generated.
- followed by some number of intervening commands. Token usage is transparent.
- finally terminate the session with a zowe zmf session zf command.
However, it is possible for such a session to time out which would invalidate the token. in which case a subequent command would return a 401 error and a message of 'No Credentials".
This would then require a new zowe zmf session zl command to be reissued to establish a new token.
Related content and resources
Please upgrade to one of the following broswers: Internet Explorer 11 (or greater) or the latest version of Chrome or Firefox