PI Powershell

RemovePIDataArchiveConnectionConfiguration Class

Save PDF

RemovePIDataArchiveConnectionConfiguration Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

Removes a connection configuration entry in the local Known Servers Table (KST)

The Remove-PIDataArchiveConnectionConfiguration cmdlet removes a connection configuration entry from the local Known Servers Table (KST). You cannot remove the default PI Data Archive from the KST with this cmdlet. Run "Get-Help Set-PIDataArchiveConnectionConfiguration -Examples" to see an example of setting another entry as the default PI Data Archive.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemovePIDataArchiveConnectionConfiguration

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Remove", "PIDataArchiveConnectionConfiguration", SupportsShouldProcess = true)]
public class RemovePIDataArchiveConnectionConfiguration : OSICmdletBase

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

Dim instance As RemovePIDataArchiveConnectionConfiguration

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

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

The RemovePIDataArchiveConnectionConfiguration type exposes the following members.

Constructors

	Name	Description
	RemovePIDataArchiveConnectionConfiguration

Properties

	Name	Description
	Name	The name of the connection configuration entry in the local Known Servers Table (KST) to remove.

Examples

Remove-PIDataArchiveConnectionConfiguration -Name PISRV1

This example removes the Known Servers Table (KST) entry for PISRV1. Note that PISRV1 cannot be the default PI Data Archive.

PI Powershell