PI Powershell

AddPIUserToPIGroup Class

Save PDF

TABLE OF CONTENTS

AddPIUserToPIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Add an existing PI User to PI Groups on a PI Data Archive

The Add-PIUserToPIGroups cmdlet adds an existing PI User to the specified PI Groups 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.PowerShellAddPIUserToPIGroup

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

Syntax

[CmdletAttribute("Add", "PIUserToPIGroup", SupportsShouldProcess = true)]
public class AddPIUserToPIGroup : OSICmdletBaseWithConnection

<CmdletAttribute("Add", "PIUserToPIGroup", SupportsShouldProcess := true)>
Public Class AddPIUserToPIGroup
	Inherits OSICmdletBaseWithConnection

Dim instance As AddPIUserToPIGroup

[CmdletAttribute(L"Add", L"PIUserToPIGroup", SupportsShouldProcess = true)]
public ref class AddPIUserToPIGroup : public OSICmdletBaseWithConnection

[<CmdletAttribute("Add", "PIUserToPIGroup", SupportsShouldProcess = true)>]
type AddPIUserToPIGroup =  
    class
        inherit OSICmdletBaseWithConnection
    end

The AddPIUserToPIGroup type exposes the following members.

Constructors

	Name	Description
	AddPIUserToPIGroup

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to add the PI User to the PI Groups (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI User to add to PI Groups
	PIGroups	PI Groups for which to add the PI User

Examples

Add-PIUserToPIGroups -Name "John Doe" -PIGroups "PIEngineersGroup","PIReadersGroup" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example adds an existing PI User "John Doe" to two PI Groups "PIEngineersGroup" and "PIReadersGroup".

PI Powershell