PI Powershell

GetPIUpdateManagerConsumerStatistics Class

Save PDF

TABLE OF CONTENTS

GetPIUpdateManagerConsumerStatistics Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get PI Update Manager consumer statistics for a PI Data Archive

The Get-PIUpdateManagerConsumerStatistics cmdlet gets the consumer statistics for a PI Data Archive server

The connection parameter specifies which connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIUpdateManagerConsumerStatistics

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

Syntax

[CmdletAttribute("Get", "PIUpdateManagerConsumerStatistics", SupportsShouldProcess = true)]
public class GetPIUpdateManagerConsumerStatistics : OSICmdletBase

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

Dim instance As GetPIUpdateManagerConsumerStatistics

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

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

The GetPIUpdateManagerConsumerStatistics type exposes the following members.

Constructors

	Name	Description
	GetPIUpdateManagerConsumerStatistics

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to retrieve update manager consumer statistics
	Name	Consumer name for which to retrieve statistics. Wildcards are supported.

Examples

Get-PIUpdateManagerConsumerStatistics -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Update Manager consumer statistics for all consumers on the "PISRV1" PI Data Archive server

Examples

Get-PIUpdateManagerConsumerStatistics -Name *ProcBook* -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Update Manager consumer statistics for all consumers matching the string "*procbook*" (ProcessBook consumers) on the "PISRV1" PI Data Archive server

PI Powershell