PI Powershell

AddPIIdentity Class

Save PDF

TABLE OF CONTENTS

AddPIIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

AddPIIdentity 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.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellAddPIIdentity

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

Syntax

[CmdletAttribute("Add", "PIIdentity", SupportsShouldProcess = true)]
public class AddPIIdentity : OSICmdletBaseWithConnection

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

Dim instance As AddPIIdentity

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

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

The AddPIIdentity type exposes the following members.

Constructors

	Name	Description
	AddPIIdentity

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to add the PI Identity (Overrides OSICmdletBaseWithConnectionConnection.)
	Description	Description of the PI Identity to add
	Disabled	Mark the PI Identity to add as disabled
	DisallowDelete	Disallow deletion of the PI Identity to add
	DisallowUseInMappings	Disallow use in mappings for the PI Identity to add
	DisallowUseInTrusts	Disallow use in mappings for the PI Identity to add
	Name	Name of the PI Identity to add

Examples

Add-PIIdentity -Name "FloorEngineers" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Add the PI Identity "FloorEngineers" from the "PISRV1" PI Data Archive server.

Examples

Add-PIIdentity -Name "BusinessDomainUsers" -Description "Identity for business domain users" -DisallowUseInTrusts -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Add the PI Identity "BusinessDomainUsers" on the "PISRV1" PI Data Archive server. A description is added. The Identity is also marked to disallow use in trusts, since this identity is intended for business users with valid PI Mappings.

PI Powershell