Migrate the known servers table (KST) using PI Server tools
- Last UpdatedSep 30, 2024
- 2 minute read
- PI System
- PI Server 2024 R2
- PI Server
An AVEVA PI System 2024 installation includes the known server table (KST) migration tool as part of the PI AF Client 2024 deployment. This utility carries out the migration of registry-based KST entries to a file-based system.
When the tool is executed, it first checks if a valid (non-empty) KST configuration file already exists. If such a file is detected, the tool exits without migrating, and also issues a warning to prevent accidental overwriting of the existing file. However, if you need to force a migration—for instance, updating the KST file with current entries from the PI SDK KST in the Windows registry—the tool can be called manually with the /forceoverwrite command-line switch. In this scenario, the tool will clear all entries in the existing KST file and repopulate it with the entries from the Windows registry.
To start the KST tool, see Open the KST migration tool.
Command-line switches
The KST migration tool offers several command-line switches to customize its behavior during the migration process. This table includes is a list of available switches and important notes on their usage.
|
Switch |
Usage |
|---|---|
|
/SuppressUI |
Hides the console window during the tool's execution. This switch is useful for running the tool silently as part of an automated script. |
|
/ForceOverwrite |
Forces the migration process even if a KST file already exists. The existing KST file will be renamed, and a new file containing the migrated content will replace it. This is especially important when ensuring that the latest configurations are applied. |
|
/OutputFile |
Specifies the file path where the migrated content will be written. This switch is particularly useful for testing purposes, allowing users to verify the migrated content before committing to the migration. However, note that the PI AF SDK cannot recognize KST files located outside its default configuration folders. |
|
?, /help |
Displays the help message, listing all available switches and their descriptions. |
Code examples of command-line switches for the KST migration tool
Below are examples of how to use the KST migration tool with different command-line switches.
Code example: Basic migration using the KST migration tool
This command performs the migration without displaying the console window and overwrites the existing KST file.
KSTMigrationTool.exe/SuppressUI/ForceOverwrite
Code example: How to output migrated content to a file
This command performs the migration and outputs the migrated content to the specified file path. This can be useful for validation purposes.
KSTMigrationTool.exe/OutputFile:C:\path\to\output\KST_migrated.txt
Additional considerations
-
Testing before migration: It is recommended to use the /OutputFile switch to validate the migrated KST content before committing to the migration process. This helps ensure that the migration will not disrupt your PI Server configurations.
-
AF SDK compatibility: Keep in mind that KST files created or moved to locations outside of the common configuration folders may not be recognized by the AF SDK. Always verify that the migrated KST file is in a proper location after testing.
-
Automated deployments: The /SuppressUI switch is particularly useful for automated deployments or when integrating the migration tool into larger scripts, allowing for seamless background execution.