PI Powershell

ClearPIBufferHealthIssue Class

Save PDF

TABLE OF CONTENTS

ClearPIBufferHealthIssue Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Clear health issues from PI Buffer Subsystem

The Clear-PIBufferHealthIssue cmdlet clears health issues on the local PI Buffer Subsystem. Health issues are cleared by Issue ID, and can be further constrained by buffered server. Multiple Health Ids can be cleared at once.

This cmdlet is analogous to pibufss.exe -health -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.PowerShellClearPIBufferHealthIssue

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

Syntax

[CmdletAttribute("Clear", "PIBufferHealthIssue", DefaultParameterSetName = "HealthIDs", 
	SupportsShouldProcess = true)]
public class ClearPIBufferHealthIssue : OSICmdletBase

<CmdletAttribute("Clear", "PIBufferHealthIssue", DefaultParameterSetName := "HealthIDs", 
	SupportsShouldProcess := true)>
Public Class ClearPIBufferHealthIssue
	Inherits OSICmdletBase

Dim instance As ClearPIBufferHealthIssue

[CmdletAttribute(L"Clear", L"PIBufferHealthIssue", DefaultParameterSetName = L"HealthIDs", 
	SupportsShouldProcess = true)]
public ref class ClearPIBufferHealthIssue : public OSICmdletBase

[<CmdletAttribute("Clear", "PIBufferHealthIssue", DefaultParameterSetName = "HealthIDs", 
	SupportsShouldProcess = true)>]
type ClearPIBufferHealthIssue =  
    class
        inherit OSICmdletBase
    end

The ClearPIBufferHealthIssue type exposes the following members.

Constructors

	Name	Description
	ClearPIBufferHealthIssue

Properties

	Name	Description
	HealthIssueId	Health Issue ID(s) to clear
	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

Clear-PIBufferHealthIssue -HealthIssueID 11

Clears the health issue ID 11 (User disabled data sending -bc stop command)

Examples

Clear-PIBufferHealthIssue -HealthIssueID 7,11

Clears the health issue ID 7,11 (There are issues with physical server(s), User disabled data sending -bc stop command, respectively)

Examples

Invoke-Command -ComputerName PIINT1 -ScriptBlock { Clear-PIBufferHealthIssue -HealthIssueID 7 }

Clears the health issue ID 11 (User disabled data sending -bc stop command) from 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-PIBufferHealthIssue, 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