PI Powershell

RenamePIIdentity Class

Save PDF

TABLE OF CONTENTS

RenamePIIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Rename a PI Security Identity

The Rename-PIIdentity cmdlet renames 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.PowerShellRenamePIIdentity

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

Syntax

[CmdletAttribute("Rename", "PIIdentity", SupportsShouldProcess = true)]
public class RenamePIIdentity : OSICmdletBaseWithConnection

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

Dim instance As RenamePIIdentity

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

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

The RenamePIIdentity type exposes the following members.

Constructors

	Name	Description
	RenamePIIdentity

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to rename the PI Identity (Overrides OSICmdletBaseWithConnectionConnection.)
	ExistingName	Name of the PI Identity to change
	NewName	New name for the PI Identity

Examples

Rename-PIIdentity -ExistingName "FloorEngineers" -NewName "ProductionLine_Engineers" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

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

PI Powershell