PI Powershell

GetPIBufferHealth Class

Save PDF

GetPIBufferHealth Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get PI Buffer Subsystem health information

The Get-PIBufferHealth cmdlet gets the buffering health information object for the specified physical server which is part of the specified logical server. This cmdlet can only be directly run against the local instance of PI Buffer Subsystem.

This cmdlet can be run against remote PI Buffer Subsystems by leveraging PowerShell Remoting.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIBufferHealth

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

Syntax

[CmdletAttribute("Get", "PIBufferHealth", SupportsShouldProcess = true)]
public class GetPIBufferHealth : OSICmdletBase

<CmdletAttribute("Get", "PIBufferHealth", SupportsShouldProcess := true)>
Public Class GetPIBufferHealth
	Inherits OSICmdletBase

Dim instance As GetPIBufferHealth

[CmdletAttribute(L"Get", L"PIBufferHealth", SupportsShouldProcess = true)]
public ref class GetPIBufferHealth : public OSICmdletBase

[<CmdletAttribute("Get", "PIBufferHealth", SupportsShouldProcess = true)>]
type GetPIBufferHealth =  
    class
        inherit OSICmdletBase
    end

The GetPIBufferHealth type exposes the following members.

Constructors

	Name	Description
	GetPIBufferHealth

Properties

	Name	Description
	LogicalServerName	Logical server name. This is the PI Collective name for collectives, or the server name for standalone PI Data Archive servers
	PhysicalServerName	Physical server name. This is the member node name for PI Collectives, or the server name for standalone PI Data Archive servers. If not specified for a PI Collective, all member sessions will be included. This parameter is not required for a standalone PI Data Archive server.

Examples

Get-PIBufferHealth -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1

Gets the buffering health information object from the local instance of PI Buffer Subsystem for the PISRV-1 physical server, which is a member of PISRV-Collective.

Examples

Invoke-Command -ComputerName PIINT1 -ScriptBlock { Get-PIBufferHealth -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1 }

Gets the buffering health information object from the PIINT1 instance of PI Buffer Subsystem for the PISRV-1 physical server, which is a member of PISRV-Collective.

Note the use of Invoke-Command.Failure of this example to execute properly is likely not an issue with Get-PIBufferHealth, but with the network or PS connection to the remote computer. Note that the OSIsoft.PowerShell module must be installed on the remote computer as well for this to work.

PI Powershell