PI Powershell

RemovePIUserFromPIGroup Class

Save PDF

TABLE OF CONTENTS

RemovePIUserFromPIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove a PI User from PI Groups on a PI Data Archive

The Remove-PIUserFromPIGroup 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.PowerShellRemovePIUserFromPIGroup

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

Syntax

[CmdletAttribute("Remove", "PIUserFromPIGroup", SupportsShouldProcess = true)]
public class RemovePIUserFromPIGroup : OSICmdletBaseWithConnection

<CmdletAttribute("Remove", "PIUserFromPIGroup", SupportsShouldProcess := true)>
Public Class RemovePIUserFromPIGroup
	Inherits OSICmdletBaseWithConnection

Dim instance As RemovePIUserFromPIGroup

[CmdletAttribute(L"Remove", L"PIUserFromPIGroup", SupportsShouldProcess = true)]
public ref class RemovePIUserFromPIGroup : public OSICmdletBaseWithConnection

[<CmdletAttribute("Remove", "PIUserFromPIGroup", SupportsShouldProcess = true)>]
type RemovePIUserFromPIGroup =  
    class
        inherit OSICmdletBaseWithConnection
    end

The RemovePIUserFromPIGroup type exposes the following members.

Constructors

	Name	Description
	RemovePIUserFromPIGroup

Properties

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

Examples

Remove-PIUserFromPIGroup -Name "John Doe" -PIGroups "PIEngineersGroup","PIReadersGroup" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example removes the PI User "John Doe" from two PI Groups "PIEngineersGroup" and "PIReadersGroup" on the "PISRV1" PI Data Archive.

PI Powershell