Migrate platforms using the Platform Migration tool

This topic describes how to automatically migrate platforms from PMTerminal to TPC using the Platform Migration tool.

Overview

The Platform Migration tool facilitates the migration of platforms from PMTerminal to TPC. The tool first identifies the platforms in a Vault whose plugin runs with PMTerminal, and then migrates the platforms to TPC.

The Platform Migration tool provides you with two options to migrate platforms:

  • Scan all platforms in the Vault and then automatically migrate the platforms from PMTerminal to TPC (without user intervention)

  • Scan, review, and migrate, which can be performed in two phases:

    • First, scan all platforms in the Vault, and then review the results in the CSV file created by the scan.

    • Second, select the platforms in the CSV file that you want to migrate, and perform the migration.

Use only one of the options that the tool provides to migrate your platforms.

Requirements

Software requirements

The machine that you run the Platform Migration tool on must meet the following software requirements:

  • Windows 2019, 2016, 2012, 10

  • .NET 4.8

  • Access to The Vault over port 1858

Permissions

The user running the tool must be a member of the Vault Admin group.

Migrate platforms to TPC

Option 1 - Migrate all platforms from PMTerminal to TPC automatically

  1. Download the tool from the marketplace.

  2. Unzip the tool file.

  3. Update the Vault.ini file with the address of the Vault.

  4. In a Command window, enter .\PMTerminalToTPCTool.exe Vault.ini ConvertAll <username> <password>.

  5. Review the results in the updated CSV file, and resolve any errors that occur.

  6. Test the migrated platforms to make sure the plugins run as expected with TPC by triggering a password change and/or password verify using each plugin.

    If a plugin doesn't run as expected, see Migrate plugins from PMTerminal to TPC for more information.

Option 2 - Scan and review existing platforms, and migrate platforms from PMTerminal to TPC

Step 1: Scan and review existing platforms

  1. Download the tool from the marketplace.

  2. Unzip the tool file.

  3. Update the Vault.ini file with the address of the Vault.

  4. Scan for platforms with PMTerminal. In a Command window, enter .\PMTerminalToTPCTool.exe Vault.ini RunScan <username> <password>.

    A CSV file is created that contains a list of all platforms with PMTerminal, along with the following information for each platform:

    Parameter

    Description

    PlatformID

    The ID string of the platform.

    Name

    The name of the platform.

    PromptsFilename

    The name of the plugin that the platform runs.

    ProcessFilename

    The name of the plugin that the platform runs.

    IsPluginTested

    If the plugin is certified by CyberArk, this will be set to Yes. This means it is safe to migrate the plugin to TPC. If the plugin is not certified, you should validate it before migrating it to TPC.

  5. Review the results, and perform any testing as needed.

Step 2: Migrate platforms from PMTerminal to TPC

  1. Select the platforms that you want to migrate. In the CSV file created by the scan in Step 1 above, enter Yes in the Convert column for each platform that you want to migrate to TPC.

    • For those platforms that have the IsPluginTested column set to Yes in the CSV file, we strongly recommend that you migrate those platforms to TPC.

    • You can remove lines (platforms) from the CSV file if you do not want to make any changes for specific platforms.

    • You don't have to migrate all platforms at one time. You can split the CSV file into two or more files, and migrate a number of platforms according to your schedule.

  2. Migrate the platforms. On every CPM machine, in a Command window, enter .\PMTerminalToTPCTool.exe Vault.ini UpdatePlatforms <username> <password> <Updated CSV filename>.

    Use the same CSV file when performing the command on each CPM machine.

    A new results CSV file is created with an additional column that indicates the migration status of each platform.

  3. Review the CSV file, and resolve any errors that occurred during the migration process.

  4. Test the migrated platforms to make sure the plugins run as expected with TPC by triggering a password change and/or password verify using each plugin.

    If a plugin doesn't run as expected, see Migrate plugins from PMTerminal to TPC for more information.