Data Archive Reference

Operate PI Data Archive utilities remotely

Save PDF

Save PDF

You can use the -node option to remotely invoke the following Data Archive utilities: piconfig, piartool, pigetmsg, and pilistupd.

Note: Specify no more than one authentication method.

-node Argument or Option	Description
computerID	The remote Data Archive computer to connect to. Specify the IP address or host name. The default is localhost.
-port portID	Communicate with the remote Data Archive server over the specified TCP/IP port. The default is 5450.
-windows	Authenticate the connection to the remote computer with a Windows operating system mechanism, either Active Directory or local Windows security.
-trust	Authenticate the connection to the remote computer with a PI trust.
-explicit	Authenticate the connection to the remote compute with password authentication (explicit login). Use additional options to specify the account and password: username piuser — Log in to the remote computer using the account piuser. The default account is piadmin. password pipassword — Log in to the remote computer using the password pipassword. The default password is blank.
-oidc	Authenticate using OpenID Connect (OIDC). Use with: -clientid clientid — The client ID used to register the application (AF Server, PI Data Archive, PI Notifications) via Aveva.PI.OIDCConfigurationTool. clientsecret clientsecret — The client secret associated with the registered application on the AIM server.
-allowlocaltcp	Use when locally connecting with OIDC authentication to PI Server.
-authdebug	Display debug output for the remote connection. Includes authentication method, protocol details, and connection status.

To run the piartool utility and display the archive list on a remote server named MyDataServer1, use one of the following authentication methods:

Windows authentication

piartool -node MyDataServer1 -Windows -al

Explicit login authentication

piartool -node MyDataServer1 -explicit -username mypiuser -password march380 -al

OIDC authentication

piartool -remote -node MyDataServer1 -oidc -clientid clientid -clientsecret clientsecret -al

Using piconfig with remote arguments

When entering piconfig arguments at the command prompt, place them before the -node option:

piconfig input piarc.dif -node PISRV1-port 5450 -username piadmin -password myadminpassword

Legacy support: In PI Server versions prior to 3.4.380, the -remote option was used to invoke utilities remotely. This option is still supported, but the -node option is now recommended.
Licensing requirement: You can run the pigetmsg utility remotely from a client computer. All other utilities must be run remotely from a Data Archive machine due to licensing restrictions.