PI Powershell

GetPIDataArchiveConnectionConfiguration Class

Save PDF

TABLE OF CONTENTS

GetPIDataArchiveConnectionConfiguration Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get connection configuration information for a PI Data Archive from the Known Servers Table (KST)

The Get-PIDataArchiveConnectionConfiguration cmdlet gets entries from the Known Servers Table (KST) which contain locally saved connection configuration information for connecting to PI Data Archive servers.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIDataArchiveConnectionConfiguration

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

Syntax

[CmdletAttribute("Get", "PIDataArchiveConnectionConfiguration", DefaultParameterSetName = "GetByName", 
	SupportsShouldProcess = true)]
public class GetPIDataArchiveConnectionConfiguration : OSICmdletBase

<CmdletAttribute("Get", "PIDataArchiveConnectionConfiguration", DefaultParameterSetName := "GetByName", 
	SupportsShouldProcess := true)>
Public Class GetPIDataArchiveConnectionConfiguration
	Inherits OSICmdletBase

Dim instance As GetPIDataArchiveConnectionConfiguration

[CmdletAttribute(L"Get", L"PIDataArchiveConnectionConfiguration", DefaultParameterSetName = L"GetByName", 
	SupportsShouldProcess = true)]
public ref class GetPIDataArchiveConnectionConfiguration : public OSICmdletBase

[<CmdletAttribute("Get", "PIDataArchiveConnectionConfiguration", DefaultParameterSetName = "GetByName", 
	SupportsShouldProcess = true)>]
type GetPIDataArchiveConnectionConfiguration =  
    class
        inherit OSICmdletBase
    end

The GetPIDataArchiveConnectionConfiguration type exposes the following members.

Constructors

	Name	Description
	GetPIDataArchiveConnectionConfiguration

Properties

	Name	Description
	Default	Forces only the default PI Data Archive connection configuration to be returned.
	Name	Specifies which connection configuration entry from the Known Servers Table (KST) to retrieve. If no value is specified, then all entries are returned.

Examples

Get-PIDataArchiveConnectionConfiguration -Default

This example will get the PI Data Archive connection configuration from the Known Servers Table (KST) for the default PI Data Archive.

Examples

Get-PIDataArchiveConnectionConfiguration

This example will get the PI Data Archive connection configuration from the Known Servers Table (KST) for all PI Data Archive servers in the KST.

Examples

Get-PIDataArchiveConnectionConfiguration -Name PISRV1

This example will get the PI Data Archive connection configuration from the Known Servers Table (KST) for the PI Data Archive "PISRV1".

PI Powershell