PI Powershell

AddPIDataArchiveConnectionConfiguration Class

Save PDF

TABLE OF CONTENTS

AddPIDataArchiveConnectionConfiguration Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Add connection configuration information for a PI Data Archive in the local Known Servers Table (KST)

The Add-PIDataArchiveConnectionConfiguration cmdlet adds an entry in the local Known Servers Table (KST) which contain locally saved connection configuration information for connecting to specific PI Data Archive servers. Note that this information is set in the same fashion for both standalone PI Data Archive servers and PI HA Collectives. If the entry points to a PI HA Collective member, then the collective configuration/information will be automatically downloaded upon first connection.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellAddPIDataArchiveConnectionConfiguration

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Add", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true)]
public class AddPIDataArchiveConnectionConfiguration : OSICmdletBase

<CmdletAttribute("Add", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess := true)>
Public Class AddPIDataArchiveConnectionConfiguration
	Inherits OSICmdletBase

Dim instance As AddPIDataArchiveConnectionConfiguration

[CmdletAttribute(L"Add", L"PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true)]
public ref class AddPIDataArchiveConnectionConfiguration : public OSICmdletBase

[<CmdletAttribute("Add", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true)>]
type AddPIDataArchiveConnectionConfiguration =  
    class
        inherit OSICmdletBase
    end

The AddPIDataArchiveConnectionConfiguration type exposes the following members.

Constructors

	Name	Description
	AddPIDataArchiveConnectionConfiguration

Properties

	Name	Description
	DefaultServer	Make this server the default PI Data Archive.
	Name	The machine name of the PI Data Archive.
	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)
	OperationTimeout	Timeout for 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)
	Path	The network path to the PI Data Archive. This can be a machine name, IP address, or Fully Qualified Domain Name (FQDN).
	Port	TCP Port to use to connect to PI Data Archive. Typically set to "5450".

Examples

Add-PIDataArchiveConnectionConfiguration -Name PISRV1 -Path "PISRV1.example.int" -OpenTimeout 00:01:00 -OperationTimeout 00:10:00

This example will add the PI Data Archive connection configuration in the Known Servers Table (KST) named "PISRV1" with an FQDN path of "PISRV1.example.int", OpenTimeout of 1 minute and OperationTimeout of 10 minutes.

Examples

Add-PIDataArchiveConnectionConfiguration -Name PISRV1 -Path "10.32.49.71" -OpenTimeout 00:00:30 -OperationTimeout 00:05:00 -DefaultServer

This example will add the PI Data Archive connection configuration in the Known Servers Table (KST) named "PISRV1" with an IP address path of "10.32.49.71", OpenTimeout of 30 seconds and OperationTimeout of 5 minutes. PISRV1 will also be set as the default PI Data Archive in the KST.

PI Powershell