@broadcom/file-master-plus-for-zowe-cli v5.0.2

File Master Plus Plug-in for Zowe CLI

The File Master Plus Plug-in for Zowe CLI helps you quickly create, edit, and manipulate files in virtual storage access method (VSAM), sequential, and partitioned data sets.

• How the plug-in works
• Software requirements
• Installing
• Uninstalling
• Example Use Cases

How the plug-in works

• The plug-in defines an FMP profile to manage the connection information, which is required to access the FMP API.
• It implements a local API to interface with the relevant API on the server.
• The plug-in creates a wrapping CLI around the local API to provide the command-line function.

Software requirements

Before you install and use the plug-in, complete the following tasks:

1. Install Zowe CLI on your computer. For more information, see Installing Zowe CLI.
2. Ensure that File Master Plus version 12 or later is installed and running in your mainframe environment.
3. Complete one of the following two tasks:
   • Integrate the FMP REST API with the API Mediation Layer (API ML).
   • Connect the plug-in directly to the File Master Plus REST API.

For more information, see the File Master Plus documentation.

Installing

To install the plug-in, use the online registry. For more information, see Installing Zowe CLI plug-ins.

After the installation process completes, it validates that the plug-in was installed correctly and that the names of its commands, options, and arguments do not conflict with those of your other Zowe CLI plug-ins.

If the validation process is successful, the following message displays:

Validation results for plugin 'file-master-plus-for-zowe-cli':
Successfully validated.

If an unsuccessful message displays, troubleshoot the installation by addressing the issues that the message describes. You can also review the information in the log file in the Zowe CLI home directory.

Uninstalling

To uninstall the plug-in, issue the following command:

zowe plugins uninstall @broadcom/file-master-plus-for-zowe-cli

Example Use Cases:

As an application developer, you can use the plug-in to perform the following tasks:

• CREATE
  Allocate a VSAM data set along with its components, copying the parameters of an existing VSAM file.
• POPULATE
  Populate a VSAM file with newly constructed test data stored in a JSON file.
• COPY
  Copy a whole VSAM file using only one CLI command. Selects desired parts of the source of a file and copies only those parts over to a new VSAM file.
• RENAME
  Rename a VSAM file with ARCHIVE as the second qualifier.
• DELETE
  Delete a VSAM file using Zowe CLI.