List of command-line properties
- Last UpdatedDec 16, 2024
- 3 minute read
- PI System
- PI Server 2024 R2
- PI Server
|
Properties |
Description |
|---|---|
|
ADDLOCAL |
Specifies features to install. See Features specified by ADDLOCAL property for PI AF Client installation. ADDLOCAL=ALL All PI AF Client features are installed. |
|
ALLUSERS |
Specifies the per-computer or per-user installation context. A value of 1 should be specified, which is the per-computer installation. ALLUSERS=1 Install context is the computer. |
|
REBOOT |
Allows the computer to restart during the installation process. Use a value of Suppress for silent installations. REBOOT=SUPPRESS Any restart of the host computer will be suppressed until the end of the bundle installation. |
|
AF_SERVER |
Specifies the default PI AF server name (the computer where the PI AF Application Service resides) for the PI AF Client. If a value is not defined by the user and the PI AF Application Service is not resident on the target host computer, the default PI AF server name is not set during the installation. If not set, the default PI AF server name can be set manually after the installation has completed. If a value is not defined and the PI AF Application Service has already been installed on the same host computer, then the current computer will be set as the default PI AF server. The AF_SERVER property is not used during an upgrade. |
|
AFSDKONLY |
0: Default. No change to the install. 1: On a clean install, installs AF SDK only. If it is an upgrade, it will upgrade normally. |
|
SENDTELEMETRY |
0: Default value during silent installation is 0. 1: Specifies participation in the PI System Customer Feedback Program. |
|
SHUTDOWN_OPTIONS |
Specifies whether or not install should stop services and applications that have the AFSDK.dll file locked and in use at the time of the upgrade. 1: Automatically close applications and attempt to restart during the installation 2: Do not close applications. (A reboot will be required.) When not set, defaults to SHUTDOWN_OPTIONS=1 to prevent user from having to reboot at end of the installation. If option 2 is specified, SHUTDOWN_OPTIONS=2, then a reboot will be needed if it is an upgrade and the AFSDK is in use at the time of the installation. In that case an automatic reboot will occur unless the REBOOT=Suppress option is set. |
|
SKIPLAUNCHCONDITIONS |
When SKIPLAUNCHCONDITIONS=1 is used, this option bypasses verification of prerequisites and allows the .msi to install even when a condition is not met. Setting this value is NOT a recommended installation. |
Known Server Table command-line properties
Because the PI SDK is no longer installed by default with the PI AF Client, the following properties can be specified to set up the Known Server Table (KST).
|
Property |
Description |
|---|---|
|
IMPORT_KST=[value] |
Set to 1 to enable the importing of an existing KST.ini file. The KST.ini file can be exported using the PI SDK Utility. |
|
KST_INI_FILE=[path\filename] |
Specifies the path and file name of the KST.ini file (by default, it is exported as KST.ini). |
|
PI_ALIAS=[handle] |
Specifies the name of the default Data Archive handle. This setting is ignored if a default Data Archive is already defined. |
|
PI_SERVER=[network path] |
Specifies the name of the default Data Archive. This setting is ignored if a default Data Archive is already defined. If you do not define the PI_SERVER, a PI Server definition is created using the local machine name. |
|
PI_USER=[pidemo] |
Default user for the default Data Archive. |
|
NOPISDKBUFFERING=1 |
Disables PI SDK buffering through pibufss if PISDK is already installed. The default, if NOPISDKBUFFERING is specified, is not changing the buffering behavior of an existing PI-SDK installation. |