PI Powershell

SetPIDataArchiveConnectionConfiguration Class

Save PDF

TABLE OF CONTENTS

SetPIDataArchiveConnectionConfiguration Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

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

The Set-PIDataArchiveConnectionConfiguration cmdlet edits entries in the local Known Servers Table (KST) which contain locally saved connection configuration information for connecting to specific PI Data Archive servers. This information can be set for standalone PI Data Archive servers as well as PI HA Collectives.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellSetPIDataArchiveConnectionConfiguration

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

Syntax

[CmdletAttribute("Set", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true, 
	DefaultParameterSetName = "Standalone")]
public class SetPIDataArchiveConnectionConfiguration : OSICmdletBase

<CmdletAttribute("Set", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess := true, 
	DefaultParameterSetName := "Standalone")>
Public Class SetPIDataArchiveConnectionConfiguration
	Inherits OSICmdletBase

Dim instance As SetPIDataArchiveConnectionConfiguration

[CmdletAttribute(L"Set", L"PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true, 
	DefaultParameterSetName = L"Standalone")]
public ref class SetPIDataArchiveConnectionConfiguration : public OSICmdletBase

[<CmdletAttribute("Set", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true, 
	DefaultParameterSetName = "Standalone")>]
type SetPIDataArchiveConnectionConfiguration =  
    class
        inherit OSICmdletBase
    end

The SetPIDataArchiveConnectionConfiguration type exposes the following members.

Constructors

	Name	Description
	SetPIDataArchiveConnectionConfiguration

Properties

	Name	Description
	Default	Set this connection configuration entry in the Known Servers Table (KST) as the default server.
	MemberNode	Member node of a PI HA Collective to edit.
	OpenTimeout	Timeout for opening and establishing a connection to the PI Data Archive. Should be set with the syntax: "hh:mm:ss".
	OperationTimeout	Timeout for communicating with the PI Data Archive. Should be set with the syntax: "hh:mm:ss"
	Path	Network path to the PI Data Archive. This can be a hostname, IP address, or Fully Qualified Domain Name (FQDN).
	PIDataArchiveConnectionConfiguration	Entry in the local Known Servers Table (KST) to edit.
	Port	TCP port for the PI Data Archive. This is typically set to "5450".
	Priority	Priority of collective member when connecting to a PI Collective. The highest priority is "1" and decreases with incremental values "2","3", etc. Set priorty to "-1" to prevent connections to this PI Collective member.

Examples

Set-PIDataArchiveConnectionConfiguration -Path "PISRV1.example.int" -OpenTimeout 00:01:00 -OperationTimeout 00:10:00 -PIDataArchiveConnectionConfiguration $configuration

Where:

$configuration = Get-PIDataArchiveConnectionConfiguration -Name PISRV1

Edit Standalone Server Settings: This example will set the PI Data Archive connection configuration in the Known Servers Table (KST) for the "PISRV1" entry. The path is set to the FQDN of PISRV1.example.int, with an OpenTimeout of 1 minute and OperationTimeout of 10 minutes.

Examples

Set-PIDataArchiveConnectionConfiguration -MemberNode PISRV2 -Priority 2 -Path "PISRV2.example.int" -OpenTimeout 00:01:00 -OperationTimeout 00:10:00 -PIDataArchiveConnectionConfiguration $configuration

Where:

$configuration = Get-PIDataArchiveConnectionConfiguration -Name PIDA-Collective

Edit PI Collective Member Settings: This example will set the PI Data Archive connection configuration in the Known Servers Table (KST) for the "PISRV2" entry, which is a member of the PI Collective "PIDA-Collective". The path is set to the FQDN of PISRV2.example.int, a priority of "2", with an OpenTimeout of 1 minute and OperationTimeout of 10 minutes.

Examples

Set-PIDataArchiveConnectionConfiguration -Default -PIDataArchiveConnectionConfiguration $configuration

Where:

$configuration = Get-PIDataArchiveConnectionConfiguration -Name PISRV1

This example will set the PI Data Archive "PISRV1" as the default PI Data Archive in the Known Servers Table (KST).

PI Powershell