PI Powershell

RemovePIUser Class

Save PDF

TABLE OF CONTENTS

RemovePIUser Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

RemovePIUser Class

Removes an existing PI User from a PI Data Archive

The Remove-PIUser cmdlet removes an existing PI User 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.PowerShellRemovePIUser

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Remove", "PIUser", SupportsShouldProcess = true)]
public class RemovePIUser : OSICmdletBase

<CmdletAttribute("Remove", "PIUser", SupportsShouldProcess := true)>
Public Class RemovePIUser
	Inherits OSICmdletBase

Dim instance As RemovePIUser

[CmdletAttribute(L"Remove", L"PIUser", SupportsShouldProcess = true)]
public ref class RemovePIUser : public OSICmdletBase

[<CmdletAttribute("Remove", "PIUser", SupportsShouldProcess = true)>]
type RemovePIUser =  
    class
        inherit OSICmdletBase
    end

The RemovePIUser type exposes the following members.

Constructors

	Name	Description
	RemovePIUser

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to remove the PI User
	Name	Name of the PI User to remove

Examples

Remove-PIUser -Name "John Doe" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example removes an existing PI User "John Doe" from the "PISRV1" PI Data Archive. To remove multiple PI Users, rerun the command for each PI User to remove.

PI Powershell