From 042a649c62325c65a2831e6a9ab4c35778fd52d4 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 14 Feb 2024 11:10:22 -0500 Subject: [PATCH 1/2] adding deprecation content for IBM IMS CLI plug-in Signed-off-by: anaxceron --- .../cli/troubleshoot-cli-plugins.md | 5 +-- docs/user-guide/cli-extending.md | 10 ++++- docs/user-guide/cli-imsplugin.md | 22 ++++++++-- docs/user-guide/cli-installplugins.md | 41 +++++++++++++++---- docs/user-guide/cli-swreqplugins.md | 2 +- docs/user-guide/systemrequirements-cli.md | 2 +- 6 files changed, 65 insertions(+), 17 deletions(-) diff --git a/docs/troubleshoot/cli/troubleshoot-cli-plugins.md b/docs/troubleshoot/cli/troubleshoot-cli-plugins.md index 4606487493..077843ca5c 100644 --- a/docs/troubleshoot/cli/troubleshoot-cli-plugins.md +++ b/docs/troubleshoot/cli/troubleshoot-cli-plugins.md @@ -13,8 +13,7 @@ For help with error codes from a back-end vendor, refer to the vendor’s help d 1. Is there already a GitHub issue (open or closed) that covers the problem? Check the following repositories: - [IBM CICS Plug-in issues](https://github.com/zowe/zowe-cli-cics-plugin/issues) - - [IBM Db2 Database Plug-in issues](https://github.com/zowe/zowe-cli-db2-plugin/issues). - - [IBM IMS Plug-in issues](https://github.com/zowe/zowe-cli-ims-plugin/issues) + - [IBM Db2 Database Plug-in issues](https://github.com/zowe/zowe-cli-db2-plugin/issues) - [IBM MQ Plug-in issues](https://github.com/zowe/zowe-cli-mq-plugin/issues) - [IBM z/OS FTP Plug-in issues](https://github.com/zowe/zowe-cli-ftp-plugin/issues) @@ -22,4 +21,4 @@ For help with error codes from a back-end vendor, refer to the vendor’s help d 2. Try searching for the issue using the [Zowe Docs](https://docs.zowe.org/) **Search** bar. -3. Use [the Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) to reach the Zowe CLI community for assistance. +3. Use the [Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) to reach the Zowe CLI community for assistance. diff --git a/docs/user-guide/cli-extending.md b/docs/user-guide/cli-extending.md index 11dc840fc4..c77ac5fd1b 100644 --- a/docs/user-guide/cli-extending.md +++ b/docs/user-guide/cli-extending.md @@ -12,6 +12,14 @@ Plug-ins can gain control of your CLI application legitimately during the execut - [IBM® CICS Plug-in for Zowe CLI](cli-cicsplugin.md) - [IBM® Db2® Database Plug-in for Zowe CLI](cli-db2plugin.md) - [IBM® z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) -- [IBM® IMS™ Plug-in for Zowe CLI](cli-imsplugin.md) - [IBM® MQ Plug-in for Zowe CLI](cli-mqplugin.md) - [Visual Studio Code (VSCode) Extension for Zowe](ze-install.md) +- [IBM® IMS™ Plug-in for Zowe CLI](cli-imsplugin.md) + + :::warning + + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + + ::: diff --git a/docs/user-guide/cli-imsplugin.md b/docs/user-guide/cli-imsplugin.md index 40d689f64c..f080089017 100644 --- a/docs/user-guide/cli-imsplugin.md +++ b/docs/user-guide/cli-imsplugin.md @@ -1,8 +1,20 @@ # IBM® IMS™ Plug-in for Zowe CLI +:::warning + +As of Zowe v2.15, the IBM **IMS Plug-in** has been deprecated. + +No additional security updates, bug fixes, or enhancements for the plug-in are expected. + +::: + The IBM IMS Plug-in for Zowe CLI lets you extend Zowe CLI such that it can interact with IMS resources (regions, programs and transactions). You can use the plug-in to start, stop, and query regions and start, stop, query, and update programs and transactions. -**Note:** For more information about IMS, see [IBM Information Management System (IMS)](https://www.ibm.com/it-infrastructure/z/ims) on the IBM Knowledge Center. +:::note + +For more information about IMS, see [IBM Information Management System (IMS)](https://www.ibm.com/it-infrastructure/z/ims) on the IBM Knowledge Center. + +::: ## Use cases @@ -52,7 +64,11 @@ Alternatively, you can create an ims profile manually by adding a section that c 2. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. - **NOTE:** If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc` + :::note + + If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc` + + ::: 3. Add code to the "profiles" section as shown in the following example: ``` @@ -114,6 +130,6 @@ The following steps describe how to create a profile using the `zowe profiles cr zowe profiles create ims-profile imsplex1 --host ims.zowe.org –-port 1443 --user zowe --password zowepass --ims-connect-host imsconnect.zowe.org --ims-connect-port 1444 ``` -2. Press Enter. The result of the command displays as a success or failure message. +2. Press `Enter`. The result of the command displays as a success or failure message. You can now use your profile when you issue commands in the ims command group. \ No newline at end of file diff --git a/docs/user-guide/cli-installplugins.md b/docs/user-guide/cli-installplugins.md index 34645d4592..ec8aa615d4 100755 --- a/docs/user-guide/cli-installplugins.md +++ b/docs/user-guide/cli-installplugins.md @@ -2,7 +2,11 @@ Use commands in the `plugins` command group to install and manage Zowe™ CLI plug-ins. -**Important!** Plug-ins can gain control of your CLI application legitimately during the execution of commands. Install third-party plug-ins at your own risk. We make no warranties regarding the use of third-party plug-ins. +:::info Important + +Plug-ins can gain control of your CLI application legitimately during the execution of commands. Install third-party plug-ins at your own risk. We make no warranties regarding the use of third-party plug-ins. + +::: You can install the following Zowe plug-ins: - IBM® CICS® Plug-in for Zowe CLI @@ -32,18 +36,24 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art ``` zowe plugins install ``` - - **Note:** Replace `` with the installation command syntax in the following table: + + Replace `` with the installation command syntax in the following table | Plug-in | Syntax | |---------|-----------------------------| | IBM CICS Plug-in for Zowe CLI | `@zowe/cics-for-zowe-cli@zowe-v2-lts` | | IBM Db2 Plug-in for Zowe CLI| `@zowe/db2-for-zowe-cli@zowe-v2-lts` | | IBM z/OS FTP Plug-in for Zowe CLI | `@zowe/zos-ftp-for-zowe-cli@zowe-v2-lts` | - | IBM IMS Plug-in for Zowe CLI | `@zowe/ims-for-zowe-cli@zowe-v2-lts` | | IBM MQ Plug-in for Zowe CLI | `@zowe/mq-for-zowe-cli@zowe-v2-lts` | + | IBM IMS Plug-in for Zowe CLI
**DEPRECATED** | `@zowe/ims-for-zowe-cli@zowe-v2-lts` | + :::warning + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + + ::: 3. (Optional) Issue the following command to install two or more plug-ins using one command. Separate the `` names with one space. @@ -51,7 +61,11 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art zowe plugins install <@zowe/my-plugin1> <@zowe/my-plugin2> <@zowe/my-plugin3> ... ``` - **Note:** The IBM Db2 Plug-in for Zowe CLI requires additional licensing and ODBC driver configurations. If you installed the DB2 plug-in, see [IBM Db2 Plug-in for Zowe CLI](cli-db2plugin.md). + :::note + + The IBM Db2 Plug-in for Zowe CLI requires additional licensing and ODBC driver configurations. If you installed the DB2 plug-in, see [IBM Db2 Plug-in for Zowe CLI](cli-db2plugin.md). + + ::: You installed Zowe CLI plug-ins. @@ -67,7 +81,11 @@ Install plug-ins from a local package on any computer that has limited or no acc From the Zowe [Download](https://zowe.org/download/) website, click **Download Zowe CLI** to download the Zowe CLI installation package named `zowe-cli-package-*v*.*r*.*m*.zip` to your computer. - **Note:** `v` indicates the version, `r` indicates the release number, and `m` indicates the modification number + :::note + + `v` indicates the version, `r` indicates the release number, and `m` indicates the modification number. + + ::: 3. Open a command-line window, such as Windows Command Prompt. Browse to the directory where you downloaded the Zowe CLI installation package (.zip file). Issue the following command, or use your preferred method to unzip the files: @@ -94,11 +112,18 @@ Install plug-ins from a local package on any computer that has limited or no acc | IBM CICS Plug-in for Zowe CLI | `cics-for-zowe-cli.tgz` | | IBM Db2 Plug-in for Zowe CLI | `db2-for-zowe-cli.tgz` | | IBM z/OS FTP Plug-in for Zowe CLI | `zos-ftp-for-zowe-cli.tgz` | - | IBM IMS Plug-in for Zowe CLI | `ims-for-zowe-cli.tgz` | | IBM MQ Plug-in for Zowe CLI | `mq-for-zowe-cli.tgz` | + | IBM IMS Plug-in for Zowe CLI
**DEPRECATED** | `ims-for-zowe-cli.tgz` | + :::warning -You installed Zowe CLI plug-ins. + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + + ::: + + You installed Zowe CLI plug-ins. ## Validating plug-ins diff --git a/docs/user-guide/cli-swreqplugins.md b/docs/user-guide/cli-swreqplugins.md index b162d86148..374b20b6e4 100644 --- a/docs/user-guide/cli-swreqplugins.md +++ b/docs/user-guide/cli-swreqplugins.md @@ -9,9 +9,9 @@ Before you use Zowe™ CLI plug-ins, complete the following steps: | [IBM CICS Plug-in for Zowe CLI](cli-cicsplugin.md) |
  • Ensure that [IBM CICS Transaction Server v5.2 or later](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.2.0/com.ibm.cics.ts.home.doc/welcomePage/welcomePage.html) is installed and running in your mainframe environment
  • [IBM CICS Management Client Interface (CMCI)](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.2.0/com.ibm.cics.ts.clientapi.doc/topics/clientapi_overview.html) is configured and running in your CICS region.
| | [IBM Db2 Database Plug-in for Zowe CLI](cli-db2plugin.md) |
  • [Download and prepare the ODBC driver](../user-guide/cli-db2plugin.md#downloading-the-odbc-driver) (required for only package installations) and address the licensing requirements. _Perform this task before you install the plug-in_.
  • **(MacOS)** Download and Install [Xcode](https://developer.apple.com/xcode/resources/).
| [z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) |
  • Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.
  • FTP over SSL is recommended.
| | [IBM z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) |
  • Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.
  • FTP over SSL is recommended.
| -| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md) |
  • Ensure that [IBM® IMS™ v14.1.0](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_14.1.0/com.ibm.ims14.doc/ims_product_landing_v14.html) or later is installed and running in your mainframe environment.
  • Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).
  • Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance.
| | [IBM MQ Plug-in for Zowe CLI](cli-mqplugin.md) |
  • Ensure that [IBM® MQ™ v9.1.0](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.1.0/com.ibm.mq.pro.doc/q121910_.htm) or later is installed and running in your mainframe environment. Please read this blog for more information: [Exposing the MQ REST API via the Zowe API Mediation Layer](https://developer.ibm.com/messaging/2019/05/17/exposing-the-mq-rest-api-via-the-zowe-api-mediation-layer/)
| | [Visual Studio Code Extension for Zowe](../user-guide/ze-install.md) |
  • Node.js V8.0 or later
  • Access to z/OSMF; at least one profile is configured
  • Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](../user-guide/systemrequirements-zosmf.md).
| +| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md)
**DEPRECATED** |
  • **As of Zowe v2.15, the IBM IMS Plug-in has been deprecated. No additional security updates, bug fixes, or enhancements are expected.**
  • Ensure that [IBM® IMS™ v14.1.0](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_14.1.0/com.ibm.ims14.doc/ims_product_landing_v14.html) or later is installed and running in your mainframe environment.
  • Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).
  • Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance.
| **Important!** You can perform the required configurations for the plug-ins that you want to use ***before*** or ***after*** you install the plug-ins. However, if you do not perform the required configurations, the plug-ins will not function as designed. diff --git a/docs/user-guide/systemrequirements-cli.md b/docs/user-guide/systemrequirements-cli.md index 6f2d0cf67f..81e1e071c1 100644 --- a/docs/user-guide/systemrequirements-cli.md +++ b/docs/user-guide/systemrequirements-cli.md @@ -83,7 +83,7 @@ You do not need to install the full Zowe solution to install and use Zowe CLI. M Services for plug-ins must be configured and running. -Plug-ins communicate with various mainframe services. The services must be configured and running on the mainframe before issuing plug-in commands. For example, the IMS plug-in requires an instance of IBM IMS on the mainframe with IMS Connect (REST services) running. For more information, see [Software requirements for CLI plug-ins](./cli-swreqplugins.md) +Plug-ins communicate with various mainframe services. The services must be configured and running on the mainframe before issuing plug-in commands. For example, the CICS plug-in requires an instance of IBM CICS Transaction Server on the mainframe with the CICS Management Client Interface (CMCI) API running. ### Zowe CLI on z/OS is not supported From 56f1a9d052b4de83d52f6365722990cfe125df91 Mon Sep 17 00:00:00 2001 From: anaxceron Date: Wed, 14 Feb 2024 15:31:32 -0500 Subject: [PATCH 2/2] addressing Adam feedback Signed-off-by: anaxceron --- docs/user-guide/cli-extending.md | 6 ++++-- docs/user-guide/cli-idfplugin.md | 6 +++++- docs/user-guide/cli-installplugins.md | 6 +++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/cli-extending.md b/docs/user-guide/cli-extending.md index c77ac5fd1b..b36b135102 100644 --- a/docs/user-guide/cli-extending.md +++ b/docs/user-guide/cli-extending.md @@ -4,16 +4,18 @@ You can install plug-ins to extend the capabilities of Zowe™ CLI. Plug-ins :::info Important -Plug-ins can gain control of your CLI application legitimately during the execution of every command. Install third-party plug-ins at your own risk. Zowe makes no warranties regarding the use of third-party plug-ins. +Plug-ins can gain control of Zowe CLI legitimately during the execution of every command. Install third-party plug-ins at your own risk. ::: -- [Install Zowe CLI plug-ins](cli-installplugins.md) +- [Installing Zowe CLI plug-ins](cli-installplugins.md) - [IBM® CICS Plug-in for Zowe CLI](cli-cicsplugin.md) - [IBM® Db2® Database Plug-in for Zowe CLI](cli-db2plugin.md) - [IBM® z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) - [IBM® MQ Plug-in for Zowe CLI](cli-mqplugin.md) +- [IDF Plug-in for Zowe CLI](cli-idfplugin.md) - [Visual Studio Code (VSCode) Extension for Zowe](ze-install.md) + - [IBM® IMS™ Plug-in for Zowe CLI](cli-imsplugin.md) :::warning diff --git a/docs/user-guide/cli-idfplugin.md b/docs/user-guide/cli-idfplugin.md index c62b37ac62..87a74ce125 100644 --- a/docs/user-guide/cli-idfplugin.md +++ b/docs/user-guide/cli-idfplugin.md @@ -12,7 +12,11 @@ For a system administrator for the Zowe API Mediation Layer, the IDF Plug-in for The plug-in provides the `map` command. For details about the map command, see [Using](#using). -**Note:** The plug-in `help` command includes specific parameters of Zowe-profiles which are not used. +:::note + +The plug-in `help` command includes specific parameters of Zowe-profiles which are not used. + +::: ## Software requirements diff --git a/docs/user-guide/cli-installplugins.md b/docs/user-guide/cli-installplugins.md index ec8aa615d4..d2478bc8ff 100755 --- a/docs/user-guide/cli-installplugins.md +++ b/docs/user-guide/cli-installplugins.md @@ -4,7 +4,7 @@ Use commands in the `plugins` command group to install and manage Zowe™ CL :::info Important -Plug-ins can gain control of your CLI application legitimately during the execution of commands. Install third-party plug-ins at your own risk. We make no warranties regarding the use of third-party plug-ins. +Plug-ins can gain control of Zowe CLI legitimately during the execution of every command. Install third-party plug-ins at your own risk. ::: @@ -67,7 +67,7 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art ::: -You installed Zowe CLI plug-ins. + You have successfully installed Zowe CLI plug-ins. ## Installing plug-ins from a local package @@ -123,7 +123,7 @@ Install plug-ins from a local package on any computer that has limited or no acc ::: - You installed Zowe CLI plug-ins. + You have successfully installed the Zowe CLI plug-ins. ## Validating plug-ins