PI Powershell

RenamePIPoint Class

Save PDF

TABLE OF CONTENTS

RenamePIPoint Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

RenamePIPoint Class

Rename a PI Point on a PI Data Archive

The Rename-PIPoint cmdlet will rename an existing PI Point on a PI Data Archive.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRenamePIPoint

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

Syntax

[CmdletAttribute("Rename", "PIPoint", SupportsShouldProcess = true)]
public class RenamePIPoint : OSICmdletBase

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

Dim instance As RenamePIPoint

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

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

The RenamePIPoint type exposes the following members.

Constructors

	Name	Description
	RenamePIPoint

Properties

	Name	Description
	Connection	Specifies which connection to a PI Data Archive to use.
	ExistingName	Name of existing PI Point to rename.
	NewName	New name for the PI Point.

Examples

Rename-PIPoint -Name "Boiler Temp 1" -NewName "Boiler_Temperature_1" -Connection $con

This example will rename the PI Point "Boiler Temp 1" to "Boiler_Temperature_1".

PI Powershell