PI Powershell

GetPIGroup Class

Save PDF

TABLE OF CONTENTS

GetPIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

GetPIGroup Class

Gets an existing PI Group on a PI Data Archive

The Get-PIGroup cmdlet gets an existing PI Group on a PI Data Archive

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

NOTE: PI Users and PI Groups have been replaced by PI Identities. PI Identities with PI Mappings (WIS) and PI Trusts should be used to configure PI Data Archive security. See KB00833 for more information.

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIGroup", SupportsShouldProcess = true)]
public class GetPIGroup : OSICmdletBaseWithConnection

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

Dim instance As GetPIGroup

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

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

The GetPIGroup type exposes the following members.

Constructors

	Name	Description
	GetPIGroup

Properties

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

Examples

Get-PIGroup -Name "PIEngineersGroup" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example gets an existing PI Group "PIEngineersGroup" from the "PISRV1" PI Data Archive.

Examples

Get-PIGroup -Name * -Connection $con | Select-Object -Property Name,Users

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example gets a list of all PI Groups and what PI Users belong to each from the "PISRV1" PI Data Archive.

PI Powershell