PI Data Archive command-line utilities
- Last UpdatedJul 15, 2025
- 2 minute read
- PI System
- PI Server
Data Archive includes several command-line utilities that are used to configure points, monitor data flow, manage archives, and configure security settings. Use the-? argument to view details about any Data Archive command-line utility. For example:
pilistupd -?
You can use one of the following options to run a Data Archive command-line utility:
-
To run a utility from a drive that does not have PI installed, switch to the drive where PI components are installed and use %PIServer%\adm or %PIServer%\bin (piarchss.exe only)
-
To run a utility from a drive that has PI components installed, use ..\PI\adm or ..\PI\bin (piarchss.exe only)
Using %PIServer%\adm or %PIServer%\bin (piarchss.exe only) works for both of the options described above.
Note: By default, Data Archive installs its files in a folder called PI on the disk with the most available space. The PISERVER environment variable (%PISERVER%) can be used to point to this directory.
|
Executable |
Location |
Purpose |
|---|---|---|
|
apisnap.exe |
PI\adm |
Check snapshot values. |
|
ipisql.exe |
PI\adm |
Execute SQL statements directed at the Data Archive server. |
|
piarchss.exe |
PI\bin |
Manage offline archive files. |
|
piarcreate.exe |
PI\adm |
Create archive files. |
|
piartool.exe |
PI\adm |
Mount archive files, and monitor, inspect, or modify the state of a running Data Archive. |
|
piconfig.exe |
PI\adm |
Configure Data Archive databases and tables, such as the PI point database and the digital state table. |
|
pidiag.exe |
PI\adm |
Diagnose and repair the Data Archive server offline. |
|
pigetmsg.exe |
PI\adm |
View messages in the PI message log. |
|
pilistupd.exe |
PI\adm |
Monitor PI Update Manager, update producers, update consumers, and update queues. |
|
pipetest.exe |
PI\adm |
Test PI Performance Equation syntax. |
|
pisetpass.exe |
PI\adm |
Change user passwords. |
|
pisnap.bat |
PI\adm |
Start apisnap.exe against the local Data Archive server. |
|
piversion.exe |
PI\adm |
Find the version and build numbers of the Data Archive server. |
Related Links
- Operate PI Data Archive utilities remotely
- Check snapshot values using with apisnap
- Execute SQL queries using ipisql
- Manage offline archive files using piarchss
- Create archive files using piarcreate
- Use the piartool utility to manage archives and backups
- Configure Data Archive tables using piconfig
- Diagnose Data Archive issues with pidiag
- View log messages with pigetmsg
- Analyze update manager signups and queues with pilistupd
- Validate performance equation syntax with pipetest
- Change user passwords with pisetpass
- Run SQL queries with pisqlss
- Display PI Server version information with piversion