PI Powershell

GetPICollective Class

Save PDF

TABLE OF CONTENTS

GetPICollective Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get PI Data Archive Collective information from a PI Data Archive

The Get-PICollective cmdlet gets PI Data Archive Collective information from a specified PI Data Archive.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellGetPICollective

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

Syntax

[CmdletAttribute("Get", "PICollective", SupportsShouldProcess = true)]
public class GetPICollective : OSICmdletBaseWithConnection

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

Dim instance As GetPICollective

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

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

The GetPICollective type exposes the following members.

Constructors

	Name	Description
	GetPICollective

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to get the PI Data Archive Collective information (Overrides OSICmdletBaseWithConnectionConnection.)

Examples

Get-PICollective -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Data Archive Collective information from the "PISRV1" PI Data Archive server.

Examples

(Get-PICollective -Connection $con).CurrentRole.Role

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Uses the PI Data Archive Collective information to get the current role of the "PISRV1" PI Data Archive Server.

PI Powershell