PI Powershell

GetPIUpdateManagerSignupStatistics Class

Save PDF

TABLE OF CONTENTS

GetPIUpdateManagerSignupStatistics Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get PI Update Manager signup statistics for a PI Data Archive

The Get-PIUpdateManagerSignupStatistics cmdlet gets the signup 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.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellGetPIUpdateManagerSignupStatistics

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

Syntax

[CmdletAttribute("Get", "PIUpdateManagerSignupStatistics", SupportsShouldProcess = true)]
public class GetPIUpdateManagerSignupStatistics : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIUpdateManagerSignupStatistics", SupportsShouldProcess := true)>
Public Class GetPIUpdateManagerSignupStatistics
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIUpdateManagerSignupStatistics

[CmdletAttribute(L"Get", L"PIUpdateManagerSignupStatistics", SupportsShouldProcess = true)]
public ref class GetPIUpdateManagerSignupStatistics : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIUpdateManagerSignupStatistics", SupportsShouldProcess = true)>]
type GetPIUpdateManagerSignupStatistics =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIUpdateManagerSignupStatistics type exposes the following members.

Constructors

	Name	Description
	GetPIUpdateManagerSignupStatistics

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to retrieve update manager signup statistics (Overrides OSICmdletBaseWithConnectionConnection.)
	ConsumerName	Consumer name mask for which to get signup statistics
	ProducerName	Producer name mask for which to get signup statistics

Examples

Get-PIUpdateManagerSignupStatistics -Connection $con | Sort-Object -Property Producer

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Update Manager signup statistics on the "PISRV1" PI Data Archive server, then sorts the output by Producer. This is similar output to "piartool.exe -ss -sp"

Examples

Get-PIUpdateManagerSignupStatistics -Connection $con | Sort-Object -Property Pending -Descending

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Update Manager signup statistics on the "PISRV1" PI Data Archive server, then sorts the output and lists signups with most pending events first.

PI Powershell