PI Powershell

RenamePIMapping Class

Save PDF

RenamePIMapping Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Rename a PI Security Mapping

The Rename-PIMapping cmdlet renames an existing PI Security Mapping. Note that the mapping "Name" displayed in PI SMT is actually the PrincipalName property of the PI Mapping object. This cmdlet edits the Name property of the PI Mapping. So this name change will not affect what is displayed in PI SMT.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRenamePIMapping

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

Syntax

[CmdletAttribute("Rename", "PIMapping", SupportsShouldProcess = true)]
public class RenamePIMapping : OSICmdletBase

<CmdletAttribute("Rename", "PIMapping", SupportsShouldProcess := true)>
Public Class RenamePIMapping
	Inherits OSICmdletBase

Dim instance As RenamePIMapping

[CmdletAttribute(L"Rename", L"PIMapping", SupportsShouldProcess = true)]
public ref class RenamePIMapping : public OSICmdletBase

[<CmdletAttribute("Rename", "PIMapping", SupportsShouldProcess = true)>]
type RenamePIMapping =  
    class
        inherit OSICmdletBase
    end

The RenamePIMapping type exposes the following members.

Constructors

	Name	Description
	RenamePIMapping

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to get the PI Mapping
	ExistingName	Existing name of the PI Mapping
	NewName	New name of the PI Mapping

Examples

Rename-PIMapping -ExistingName "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" -NewName "Jane Doe" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Renames the PI Mapping "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" to Jane Doe on the "PISRV1" PI Data Archive server.

Note that name of the mapping is typically Windows_[WindowsSID] where [WindowsSID] is the Windows SID of the Windows User or Group the mapping is for.

Note that the mapping "Name" displayed in PI SMT is actually the PrincipalName property of the PI Mapping object. This cmdlet edits the Name property of the PI Mapping. So this name change will not affect what is displayed in PI SMT.

PI Powershell