RenamePIUser Class
- Last UpdatedDec 15, 2025
- 3 minute read
Rename an existing PI User on a PI Data Archive
The Rename-PIUser cmdlet renames 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
InternalCommand
Cmdlet
PSCmdlet
OSIsoft.PowerShellOSICmdletBase
OSIsoft.PowerShellOSICmdletBaseWithConnection
OSIsoft.PowerShellRenamePIUser
Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)
Syntax
[CmdletAttribute("Rename", "PIUser", SupportsShouldProcess = true)] public class RenamePIUser : OSICmdletBaseWithConnection
<CmdletAttribute("Rename", "PIUser", SupportsShouldProcess := true)> Public Class RenamePIUser Inherits OSICmdletBaseWithConnection Dim instance As RenamePIUser
[CmdletAttribute(L"Rename", L"PIUser", SupportsShouldProcess = true)] public ref class RenamePIUser : public OSICmdletBaseWithConnection
[<CmdletAttribute("Rename", "PIUser", SupportsShouldProcess = true)>] type RenamePIUser = class inherit OSICmdletBaseWithConnection end
The RenamePIUser type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | RenamePIUser |
Properties
| Name | Description | |
|---|---|---|
 | Connection | Connection to a PI Data Archive from which to rename the PI User |
| ExistingName | Name of the PI User to rename |
| NewName | New name of the PI User |
Examples
Remove-PIUser -Name "John Doe" -NewName "John M Doe" -Connection $con
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
This example renames an existing PI User "John Doe" to "John M Doe" on the "PISRV1" PI Data Archive.