PI Powershell

RemovePIIdentity Class

Save PDF

TABLE OF CONTENTS

RemovePIIdentity Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove a PI Security Identity

The Remove-PIIdentity cmdlet removes an existing PI Security Identity

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Remove", "PIIdentity", SupportsShouldProcess = true)]
public class RemovePIIdentity : OSICmdletBaseWithConnection

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

Dim instance As RemovePIIdentity

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

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

The RemovePIIdentity type exposes the following members.

Constructors

	Name	Description
	RemovePIIdentity

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to remove the PI Identity (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI Identity to remove

Examples

Remove-PIIdentity -Name "ProductionLine_Engineers" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Removes the PI Identity "FloorEngineers" to "ProductionLine_Engineers" on the "PISRV1" PI Data Archive server.

PI Powershell