PI Powershell

RemovePIBufferedServer Class

Save PDF

RemovePIBufferedServer Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Remove a PI Buffered Server

The Remove-PIBufferedServer cmdlet removes the specified logical buffered server. In order to use this cmdlet, the running user must be a member of either "PI Buffering Administrators" or "Administrators" local groups. This cmdlet can only be directly run against the local instance of PI Buffer Subsystem. The user will be prompted for confirmation before removing the buffered server, this can be overridden using the -Force parameter.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemovePIBufferedServer

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

Syntax

[CmdletAttribute("Remove", "PIBufferedServer", SupportsShouldProcess = true)]
public class RemovePIBufferedServer : OSICmdletBase

<CmdletAttribute("Remove", "PIBufferedServer", SupportsShouldProcess := true)>
Public Class RemovePIBufferedServer
	Inherits OSICmdletBase

Dim instance As RemovePIBufferedServer

[CmdletAttribute(L"Remove", L"PIBufferedServer", SupportsShouldProcess = true)]
public ref class RemovePIBufferedServer : public OSICmdletBase

[<CmdletAttribute("Remove", "PIBufferedServer", SupportsShouldProcess = true)>]
type RemovePIBufferedServer =  
    class
        inherit OSICmdletBase
    end

The RemovePIBufferedServer type exposes the following members.

Constructors

	Name	Description
	RemovePIBufferedServer

Properties

	Name	Description
	Force	Force the removal of the buffered server without prompting user for confirmation
	LogicalServerName	Logical server name. This is the PI Collective name for collectives, or the server name for standalone PI Data Archive servers

Examples

Remove-PIBufferSession -LogicalServerName PISRV-OldStandalone

This example removes the buffered server "PISRV1-OldStandalone" from the local PI Buffer Subsystem instance. The user is prompted for confirmation before the server is removed.

Examples

Remove-PIBufferSession -LogicalServerName PISRV-OldCollective -Force

This example removes the buffered server "PISRV1-OldCollective" from the local PI Buffer Subsystem instance. The buffered server is removed immediately without prompting for confirmation from the user.

Examples

Invoke-Command -ComputerName PIINT1 -ScriptBlock { Remove-PIBufferedServer -LogicalServerName PISRV-OldStandalone }

This example removes the buffered server "PISRV1-OldStandalone" from the PIINT1 PI Buffer Subsystem instance. The user is prompted for confirmation before the server is removed.

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