WA Plug-in for Zowe CLI

The WA Plug-in for Zowe CLI lets you issue Workload Automation commands to remotely control your workload. With Workload Automation commands, you can monitor and modify jobs, jostreams and resources, and issue WAPL commands. For information about Workload Automation commands and syntax, see the online help that is provided within the WA plug-in.

• How the plug-in works
• Software requirements
• Installing
• Creating a user profile
• Storing passwords securely
• Uninstalling

How the plug-in works

• The plug-in defines a Workload Automation profile to manage the connection information, which is required to access the WA API.
• It provides you with a CLI interface with the relevant API on the Z connector server.

Software requirements

Before you install and use the plug-in:

• Install Zowe CLI on your computer.

  Note: For more information, see Installing Zowe CLI.

• Ensure that the Z connector V9.5 Fix Pack 2 is installed and running in your environment.

• Access the WA API through the API Mediation Layer (API ML) or connect the plug-in directly to the WA API. For more information, see Using Zowe API Mediation Layer to access Workload Automation REST API

Installing

Download the ibm-workload-scheduler-zowe-cli package and install the plug-in by performing the following procedure.

1. Download the ibm-workload-scheduler-zowe-cli by issuing the following command:

   npm i ibm-workload-scheduler-zowe-cli

2. Install the WA plug-in by issuing the following command:

   zowe plugins install ibm-workload-scheduler-zowe-cli

Creating a user profile

To avoid typing your connection details on every command, you can create a wa user profile. A wa profile contains the host, port, username, password and engine for the Z connector server of your choice. You can create multiple profiles and switch between them as needed.

Follow these steps:

1. Create a wa profile:

   zowe profiles create wa-profile <profileName> --host <hostname> --port <portnumber> --user <username> --password <password>

   The result of the command displays as a success or failure message. You can use the profile when you issue commands in the wa command group.

Tip: For more information about the syntax, actions, and options, for a profiles create command, open Zowe CLI and issue the following command:

zowe profiles create wa-profile -h

Storing passwords securely

You can set the WA plug-in as the credential manager for the Zowe cli, to ensure that your credentials are stored securely in a default credential manager of your operating system. Issue the following command:

zowe config set CredentialManager ibm-workload-scheduler-zowe-cli

To revert the configuration of your credential manager to the Zowe cli default, issue the following command:

zowe config reset CredentialManager 

Uninstalling

Perform the following steps:

1. Issue the following command:

   zowe plugins uninstall ibm-workload-scheduler-zowe-cli

After the uninstallation process completes successfully, the product no longer contains the plug-in.