Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Powershell

ConnectPIDataArchive Properties

  • Last UpdatedDec 15, 2025
  • 3 minute read
ConnectPIDataArchive Properties

The ConnectPIDataArchive type exposes the following members.

Properties

  NameDescription
Public property
AccessToken

Access token to use when connecting to a PI Data Archive.

Public property
AuthenticationMethod

PI authentication method to use when connecting to a PI Data Archive.

Public property
ClientCredential

Client id and secret to get access token to use when connecting to a PI Data Archive.

Public property
OpenTimeout

Timeout for opening and establishing a connection to the PI Data Archive. Should be set with syntax "hh:mm:ss"

If not specified, the default global value from the PISDK configuration is used. (Typically 10 seconds)

Public property
OperationTimeout

Timeout used when communicating with the PI Data Archive. Should be set with syntax "hh:mm:ss"

If not specified, the default global value from the PISDK configuration is used. (Typically 60 seconds)

Public property
Password

Password for PI Username used when connecting to the PI Data Archive. Used in conjunction with PIUsername.

Note: Explicit Login has been superseded by connecting via Windows Integrated Security (WIS) or PI Trusts. It is strongly recommended to connect via these authentication methods instead of explicit login. See -AuthenticationMethod parameter for details on connecting via WIS or PI Trusts.

Public property
PIDataArchiveConnectionConfiguration

Connection configuration object retrieved from the Known Servers Table (KST). Run "Get-Help Get-PIDataArchiveConnectionConfiguration" for more details.

Public property
PIDataArchiveMachineName

Machine name of the PI Data Archive to connect to. This can be a machine name, IP address, or Fully Qualified Domain Name (FQDN).

Public property
PIUsername

PI Username to use when connecting to the PI Data Archive. Used in conjunction with Password.

Note: Explicit Login has been superseded by connecting via Windows Integrated Security (WIS) or PI Trusts. It is strongly recommended to connect via these authentication methods instead of explicit login. See -AuthenticationMethod parameter for details on connecting via WIS or PI Trusts.

Public property
Port

Port number to use when connecting to a PI Data Archive. Default is 5450.

Public property
PromptForAccessToken

Browser popup to authorize getting access token to use when connecting to a PI Data Archive.

Public property
WindowsCredential

Windows Credential to use when connecting to a PI Data Archive.

See Also

TitleResults for “How to create a CRG?”Also Available in