Spool™ Plug-in for Zowe™ CLI
The Spool™ Plug-in for Zowe™ CLI lets users issue any Spool native command from a single command-line interface. This plug-in also enables automated administration of Spool and lets service providers that administer multiple Spool environments respond to client requests faster.
- Use Cases
- Software Requirements
- Install the Plug-in
- Create Profiles
- Get Command Help
- Use the Plug-in
- Update the Plug-in
- Uninstall the Plug-in
Use Cases
You can use the Spool™ Plug-in for Zowe™ CLI to perform the following tasks:
- Set up automated administration of the Spool environment.
- Issue any Spool native command from a single command-line interface instead of switching to the MVS terminal.
- Create scripts to automate processes that you currently perform manually.
Software Requirements
Before you install and use the plug-in:
- Install Zowe CLI.
- It is highly recommended that you install the Secure Credential Store Plug-in for Zowe CLI to mask sensitive data in your Zowe profiles.
- Ensure that a z/OSMF server is up and running.
- Ensure that a Spool™ 14.0 instance is installed and running in your mainframe environment. The instance must meet the following minimum requirements:
- Release 14.0 with PTF SO12826 applied.
- See the Integrate with Zowe CLI topic in Spool documentation.
Install the Plug-in
To install the @latest version of the plug-in, issue the following command:
$ zowe plugins install @broadcom/caspool-for-zowe-cli
Note: The latest npm tag installs an active development version of the plug-in, which accepts breaking changes. You can use different npm tags to install other versions of the product. For more information about tag usage, see NPM Tag Names.
Create Profiles
You can configure zosmf and caspool profiles to avoid typing your z/OSMF, TSO account, and Spool instance information on every command.
The z/OSMF profile contains information needed to connect to z/OS with your host name, z/OSMF port, user name, and password.
The Spool profile contains your TSO account information and the following information for the Spool instance:
- Spool installation high level qualifier (HLQ)
- Subsystem name for the Spool instance
- Output response data set (must be unique for each Zowe CLI user that is interacting with Spool)
- Data set containing ESFZOWE REXX exec
You can create multiple profiles and switch between them as needed.
To create the z/OSMF profile, issue the following command:
$ zowe profiles create zosmf myProfile –-host host.company.com -–port 443 –-user USER1 –-pass password –-reject-unauthorized true
For a full specification of the available options use the --help argument:
$ zowe profiles create zosmf --help
To create the Spool profile, issue the following command:
$ zowe profiles create caspool myProfile --account 1234567890 --spoolhlq CASPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST
For a full specification of the available options use the --help argument:
$ zowe profiles create caspool --help
Get Command Help
To get help for the available command groups, issue the following command:
$ zowe caspool --help
To obtain context sensitive help, append the --help argument to your command.
For example, to get help with the issue command command, issue the following command:
$ zowe caspool issue command --help
Use the Plug-in
To issue a Spool native command, use the following format:
$ zowe caspool issue command "<ca-spool-command>"
For example, to display the status of the ESF system, issue the following command:
$ zowe caspool issue command "DS"
Update the Plug-in
To update the plug-in, issue the following command:
$ zowe plugins update @broadcom/caspool-for-zowe-cli
Uninstall the Plug-in
To uninstall the plug-in, issue the following command:
$ zowe plugins uninstall @broadcom/caspool-for-zowe-cli