Migrating Zowe profiles

Migrating Zowe v3.0 SSH profiles to Zowe Explorer 3.6

Recent updates to the Zowe CLI SDK, adopted by Zowe Explorer 3.6 and Z Open Editor 6.8.0, require SSH team configuration profiles to specify a hostKey property.

This change can affect user builds that use z/OSMF and SSH profiles, remote preprocessors, and some MCP tools that use SSH through Zowe.

To migrate SSH profiles in team configuration files, add the hostKey property. There are two ways to do that:

1. If Zowe CLI v8.36.0 or later is installed on the workstation:
   • Run an SSH command through the CLI to update the profile. For example, run zowe zos-ssh issue command "ls /var" in a terminal window.
   • If multiple SSH profiles exist, append the --ssh-profile <ssh-profile-name> parameter.
   • You are then prompted to verify the host fingerprint.
   • After confirming the fingerprint, the hostKey property is added automatically to the profile. The updated profile resembles the example below.
2. If Zowe CLI is not installed, use an SSH command to retrieve the host key value and add it manually:
   • In a terminal window, run ssh-keygen -F <hostname>. This command is available on Windows and macOS workstations when SSH is enabled. The output shows three values: the hostname, the key type, and the host key.
   • Copy the host key and add it to the SSH profile, as shown in the example below.

"ssh": {
  "type": "ssh",
  "properties": {
    "port": 22,
    "hostKey": "AAAAC3N...."
  }
},

Migrating your old Zowe yaml profiles for Zowe v3.0

When upgrading to Zowe Explorer v3.0, you will no longer be able to use your old Zowe v1 YAML based profiles. The following steps are provided in order to keep your old profiles working and utilize them in your workspace:

Migrating through Zowe Explorer VS Code Extension

1. If auto-install is disabled, update Zowe Explorer by going to "extensions > Zowe Explorer" in Visual Studio Code and clicking the Update button.

2. If Zowe v1 YAML based profiles are detected by Zowe Explorer, a modal message appears with an option to migrate them to a Team Configuration file for continued use.

Migrating through Zowe CLI

1. Review your installed Zowe plugins from Zowe CLI by running zowe plugins list and verify that the secure credential store plugin is not installed.

2. If the secure credential store plugin is installed, issue the following command in your terminal zowe scs revert --force.

3. If the secure credential store plugin is installed, run the following command to uninstall zowe plugins uninstall @zowe/secure-credential-store-for-zowe-cli.

4. Verify your plugins are updated to a version compatible with Zowe CLI v8.0.0, otherwise you can uninstall your Zowe plugins by using zowe plugins uninstall <your zowe plugin name> for each plugin installed.

5. Install the new version of Zowe CLI by running npm install -g @zowe/cli@zowe-v3-lts.

6. Run the command to convert v1 YAML profiles into a Team Configuration file, zowe config convert-profiles.