Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding deprecation content for IBM IMS CLI plug-in for Zowe V2.15 #3438

Merged
merged 3 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/troubleshoot/cli/troubleshoot-cli-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ 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)

If there is no issue on the problem, file an issue in the repository for the respective plug-in so the dev team can review it.

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.
10 changes: 9 additions & 1 deletion docs/user-guide/cli-extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
anaxceron marked this conversation as resolved.
Show resolved Hide resolved
- [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.

:::
22 changes: 19 additions & 3 deletions docs/user-guide/cli-imsplugin.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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:
```
Expand Down Expand Up @@ -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.
41 changes: 33 additions & 8 deletions docs/user-guide/cli-installplugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
anaxceron marked this conversation as resolved.
Show resolved Hide resolved

:::

You can install the following Zowe plug-ins:
- IBM® CICS® Plug-in for Zowe CLI
Expand Down Expand Up @@ -32,26 +36,36 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art
```
zowe plugins install <my-plugin>
```

**Note:** Replace `<my-plugin>` with the installation command syntax in the following table:
Replace `<my-plugin>` 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 <br/>**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 `<my-plugin>` names with one space.

```
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.
anaxceron marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -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:

Expand All @@ -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 <br/> **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.
anaxceron marked this conversation as resolved.
Show resolved Hide resolved

## Validating plug-ins

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/cli-swreqplugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Before you use Zowe&trade; CLI plug-ins, complete the following steps:
| [IBM CICS Plug-in for Zowe CLI](cli-cicsplugin.md) | <ul><li>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</li><li>[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.</li></ul> |
| [IBM Db2 Database Plug-in for Zowe CLI](cli-db2plugin.md) | <ul> <li>[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_.</li><li>**(MacOS)** Download and Install [Xcode](https://developer.apple.com/xcode/resources/).</li> </ul>| [z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) | <ul> <li>Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.</li> <li>FTP over SSL is recommended.</li> </ul> |
| [IBM z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) | <ul> <li>Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.</li> <li>FTP over SSL is recommended.</li> </ul> |
| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md) | <ul><li>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.</li><li> Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).</li> <li>Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance. </li></ul> |
| [IBM MQ Plug-in for Zowe CLI](cli-mqplugin.md) | <ul><li>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/) </li></ul>|
| [Visual Studio Code Extension for Zowe](../user-guide/ze-install.md) | <ul><li>Node.js V8.0 or later</li><li>Access to z/OSMF; at least one profile is configured</li><li>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).</li></ul>|
| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md)<br/>**DEPRECATED** | <ul><li>**As of Zowe v2.15, the IBM IMS Plug-in has been deprecated. No additional security updates, bug fixes, or enhancements are expected.**</li><li>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.</li><li> Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).</li> <li>Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance. </li></ul> |


**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.
2 changes: 1 addition & 1 deletion docs/user-guide/systemrequirements-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading