PI Powershell

GetPIIdentity Class

Save PDF

TABLE OF CONTENTS

GetPIIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

GetPIIdentity Class

Get a PI Security Identity

The Get-PIIdentity cmdlet gets 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.PowerShellGetPIIdentity

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

Syntax

[CmdletAttribute("Get", "PIIdentity", SupportsShouldProcess = true)]
public class GetPIIdentity : OSICmdletBase

<CmdletAttribute("Get", "PIIdentity", SupportsShouldProcess := true)>
Public Class GetPIIdentity
	Inherits OSICmdletBase

Dim instance As GetPIIdentity

[CmdletAttribute(L"Get", L"PIIdentity", SupportsShouldProcess = true)]
public ref class GetPIIdentity : public OSICmdletBase

[<CmdletAttribute("Get", "PIIdentity", SupportsShouldProcess = true)>]
type GetPIIdentity =  
    class
        inherit OSICmdletBase
    end

The GetPIIdentity type exposes the following members.

Constructors

	Name	Description
	GetPIIdentity

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to get the PI Identity
	Name	Name of the PI Identity to get

Examples

Get-PIIdentity -Name "PIEngineers" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Get the PI Identity "PIEngineers" from the "PISRV1" PI Data Archive server.

Examples

Get-PIIdentity -Name "*" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all PI Identities from the "PISRV1" PI Data Archive server.

Examples

(Get-PIIdentity -Name "*" -Connection $con).Name

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets a simple list of just names of PI Identities on the "PISRV1" Data Archive server.

Examples

Get-PIIdentity -Name "*" -Connection $con | Where-Object -Property IsEnabled -is $true

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets a list of only PI Identities which are enabled on the "PISRV1" Data Archive server.

PI Powershell