PI Powershell

GetPIThreadInformation Class

Save PDF

TABLE OF CONTENTS

GetPIThreadInformation Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get Thread Information for a PI Subsystem on a PI Data Archive

The Get-PIThreadInformation cmdlet gets thread information for the specified subsystem from the specified PI Data Archive.

The connection parameter specifies the connection to a PI Data Archive to use.

This cmdlet returns the same thread information output by "piartool.exe -thread <subsystem> -info"

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIThreadInformation", SupportsShouldProcess = true)]
public class GetPIThreadInformation : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIThreadInformation", SupportsShouldProcess := true)>
Public Class GetPIThreadInformation
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIThreadInformation

[CmdletAttribute(L"Get", L"PIThreadInformation", SupportsShouldProcess = true)]
public ref class GetPIThreadInformation : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIThreadInformation", SupportsShouldProcess = true)>]
type GetPIThreadInformation =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIThreadInformation type exposes the following members.

Constructors

	Name	Description
	GetPIThreadInformation

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use (Overrides OSICmdletBaseWithConnectionConnection.)
	History	Retrieves historical thread information
	Subsystem	PI Data Archive Subsystem for which to retrieve the thread information

Examples

Get-PIThreadInformation -Subsystem Archive -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the thread information objects for the PI Archive Subsystem from the PISRV1 PI Data Archive

Examples

(Get-PIThreadInformation -Subsystem Archive -Connection $con | Where-Object -Property ThreadType -EQ Flush).Details

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the historical flush thread details for the PI Archive Subsystem on the PISRV1 PI Data Archive

Examples

(Get-PIThreadInformation -Subsystem Archive -Connection $con | Where-Object -Property ThreadType -EQ RPC).Details

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the RPC thread details for the PI Archive Subsystem on the PISRV1 PI Data Archive

Examples

(Get-PIThreadInformation -Subsystem Base -Connection $con | Where-Object -Property ThreadType -EQ RPC).Details

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the RPC thread details for the PI Base Subsystem on the PISRV1 PI Data Archive

PI Powershell