@broadcom/idms-for-zowe-cli v1.2.0

IDMS Plug-in for Zowe CLI

The IDMS Plug-in for Zowe CLI allows you to execute and automate IDMS administration tasks on the mainframe by using a familiar command-line interface.

Use Cases

As a DevOps administrator you can use the plug-in to perform the following tasks:

• List all active IDMS systems on an LPAR and information about a specific system
• View DC log messages
• Issue DCMT and DCUF commands

For more information about the plug-in, see IDMS Plug-in for Zowe CLI.

Software Requirements

Ensure that you meet the following software requirements before you use the plug-in:

• IDMS 19.0 or higher
• IDMS REST API 1.0 or higher
• Zowe CLI v6.6.3 or higher, see How to install

Install the IDMS Plug-in for Zowe CLI from Packages

1. Issue the following command:

   zowe plugins install @broadcom/idms-for-zowe-cli

2. Validate the installed plug-in

   zowe plugins validate @broadcom/idms-for-zowe-cli

(Optional) Create a profile to use with the IDMS Plug-in for Zowe CLI

A profile will need to be created to use the IDMS CLI plugin.

Create a new Zowe configuration

Skip to the next step if you already have an initialized Zowe configuration.

Create a new Zowe configuration as a new zowe.config.json file in the local directory using the command:

zowe config init

Zowe CLI will prompt you for the hostname of the service. If you are using Zowe API mediation layer, enter the hostname of the mediation layer service. Otherwise, enter the hostname of the IDMS REST API service itself.

Add a profile for IDMS

First, choose a name for the IDMS profile. This will be referred to below as <idms_profile_name>. You may specify multiple IDMS REST API services by repeating the following instructions with a new name. Specify the name without spaces, either separating words with camel case (productionIdms), dashes (production-idms), or underscores (production_idms).

Run the following command. If using the Zowe API mediation layer, <port> will be the port of the mediation layer. Otherwise, it is the port of the IDMS REST API service.

zowe config set profiles.<idms_profile_name>.properties.port <port>

If using the Zowe API medation layer, run the following command where <api_ml_service_id> is the ID of the service defined to the mediation layer. Otherwise, skip this command.

zowe config set profiles.<idms_profile_name>.properties.basePath <api_ml_service_id>/api/v1

To set this profile as default, run the following command.

zowe config set defaults.idms <idms_profile_name>

If one IDMS CV will be primarily used, set a default IDMS CV to use when issuing commands by running the following command with the name of the data source as specified in the IDMS REST API service.

zowe config set profiles.<idms_profile_name>.properties.datasource <data_source_name>

To test the new profile, run the following command.

zowe idms list systems

Get Started

To get help with the IDMS Plug-in for Zowe CLI, view available command groups and instructions for their use, use the '--help' argument:

zowe idms --help

To display the help in a web browser, use the '--help-web' argument:

zowe idms --help-web

Uninstall the Plug-in

Issue the following command:

zowe plugins uninstall @broadcom/idms-for-zowe-cli