PI Powershell

GetPIBufferConfiguration Class

Save PDF

TABLE OF CONTENTS

GetPIBufferConfiguration Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get buffer configuration for a physical buffered server

The Get-PIBufferConfiguration cmdlet gets the buffer configuration for a physical buffered server. By default, this cmdlet only retrieves the Path and Queue Size configuration parameters. Use the -Details parameter to return all configuration parameters.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIBufferConfiguration

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

Syntax

[CmdletAttribute("Get", "PIBufferConfiguration", SupportsShouldProcess = true)]
public class GetPIBufferConfiguration : OSICmdletBase

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

Dim instance As GetPIBufferConfiguration

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

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

The GetPIBufferConfiguration type exposes the following members.

Constructors

	Name	Description
	GetPIBufferConfiguration

Properties

	Name	Description
	Details	Return all buffer configuration details
	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-PIBufferConfiguration -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1 -Details

Gets the complete PI buffered server configuration object from the local instance of PI Buffer Subsystem for the PISRV-1 machine, which is a member of the PISRV-Collective PI Data Archive HA Collective.

Examples

(Get-PIBufferConfiguration -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1 -Details).LogicalServers.Values.PhysicalServersBufferConfiguration.Values.Parameters

Outputs the complete PI buffered server configuration from the local instance of PI Buffer Subsystem for the PISRV-1 machine, which is a member of the PISRV-Collective PI Data Archive HA Collective.

Examples

Invoke-Command -ComputerName PIINT1, PIINT2 -ScriptBlock { Get-PIBufferConfiguration -LogicalServerName PISRV-Collective -PhysicalServerName PISRV-1 -Details }

Gets the PI buffered server information object from the PIINT1 and PIINT2 instances of PI Buffer Subsystem for the PISRV-1 machine, which is a member of the PISRV-Collective PI Data Archive HA Collective.

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