PI Powershell

ClearPIBufferPointError Class

Save PDF

TABLE OF CONTENTS

ClearPIBufferPointError Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Clear point errors from PI Buffer Subsystem

The Clear-PIBufferPointError cmdlet clears point errors on the local PI Buffer Subsystem. Errors are cleared by PointID, and can be further constrained by buffered server. Multiple PointIDs can be specified and cleared at once.

This cmdlet is analogous to pibufss.exe -pointerr -clear ... options

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellClearPIBufferPointError

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

Syntax

[CmdletAttribute("Clear", "PIBufferPointError", DefaultParameterSetName = "Logical", 
	SupportsShouldProcess = true)]
public class ClearPIBufferPointError : OSICmdletBase

<CmdletAttribute("Clear", "PIBufferPointError", DefaultParameterSetName := "Logical", 
	SupportsShouldProcess := true)>
Public Class ClearPIBufferPointError
	Inherits OSICmdletBase

Dim instance As ClearPIBufferPointError

[CmdletAttribute(L"Clear", L"PIBufferPointError", DefaultParameterSetName = L"Logical", 
	SupportsShouldProcess = true)]
public ref class ClearPIBufferPointError : public OSICmdletBase

[<CmdletAttribute("Clear", "PIBufferPointError", DefaultParameterSetName = "Logical", 
	SupportsShouldProcess = true)>]
type ClearPIBufferPointError =  
    class
        inherit OSICmdletBase
    end

The ClearPIBufferPointError type exposes the following members.

Constructors

	Name	Description
	ClearPIBufferPointError

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.
	PointId	PointID(s) for which to clear errors

Examples

Clear-PIBufferPointError

Clears all point errors for all servers on the local instance of PI Buffer Subsystem.

Examples

Clear-PIBufferPointError -PointID 1,2,3

Clears point errors for PI Points with PointID 1, 2 and 3 on the local instance of PI Buffer Subsystem.

Examples

Clear-PIBufferPointError -PointID 1,2,3 -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1

Clears point errors for PI Points with PointID 1, 2 and 3 from the PISRV-1 buffered server on the local instance of PI Buffer Subsystem.

Examples

Invoke-Command -ComputerName PIINT1 -ScriptBlock { Clear-PIBufferPointError -PointID 1 -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1 }

Clears point errors for PI Point with PointID 1 on the PIINT1 instance of PI Buffer Subsystem.

Note the use of Invoke-Command. Failure of this example to execute properly is likely not an issue with Clear-PIBufferPointError, 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