PI Powershell

DisconnectPIDataArchive Class

Save PDF

TABLE OF CONTENTS

DisconnectPIDataArchive Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Gracefully disconnect from a PI Data Archive

The Disconnect-PIDataArchive cmdlet allows a connection to be gracefully disconnected from a PI Data Archive.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellDisconnectPIDataArchive

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

Syntax

[CmdletAttribute("Disconnect", "PIDataArchive", SupportsShouldProcess = true)]
public class DisconnectPIDataArchive : OSICmdletBaseWithConnection

<CmdletAttribute("Disconnect", "PIDataArchive", SupportsShouldProcess := true)>
Public Class DisconnectPIDataArchive
	Inherits OSICmdletBaseWithConnection

Dim instance As DisconnectPIDataArchive

[CmdletAttribute(L"Disconnect", L"PIDataArchive", SupportsShouldProcess = true)]
public ref class DisconnectPIDataArchive : public OSICmdletBaseWithConnection

[<CmdletAttribute("Disconnect", "PIDataArchive", SupportsShouldProcess = true)>]
type DisconnectPIDataArchive =  
    class
        inherit OSICmdletBaseWithConnection
    end

The DisconnectPIDataArchive type exposes the following members.

Constructors

	Name	Description
	DisconnectPIDataArchive

Properties

	Name	Description
	Connection	Specifies which connection to a PI Data Archive to disconnect. (Overrides OSICmdletBaseWithConnectionConnection.)

Examples

Disconnect-PIDataArchive -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName PISRV1

This example will gracefully disconnect from the PI Data Archive "PISRV1" as specified by the -Connection parameter.

PI Powershell