PI Powershell

SetPIPoint Class

Save PDF

TABLE OF CONTENTS

SetPIPoint Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

SetPIPoint Class

Set the attributes of a PI Point

The Set-PIPoint cmdlet edits point attribute values for a pre-existing PI Point. The attributes to edit are passed in as a hashtable.

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

NOTE: To rename a PI Point, use the Rename-PIPoint cmdlet.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellSetPIPoint

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

Syntax

[CmdletAttribute("Set", "PIPoint", SupportsShouldProcess = true)]
public class SetPIPoint : OSICmdletBaseWithConnection

<CmdletAttribute("Set", "PIPoint", SupportsShouldProcess := true)>
Public Class SetPIPoint
	Inherits OSICmdletBaseWithConnection

Dim instance As SetPIPoint

[CmdletAttribute(L"Set", L"PIPoint", SupportsShouldProcess = true)]
public ref class SetPIPoint : public OSICmdletBaseWithConnection

[<CmdletAttribute("Set", "PIPoint", SupportsShouldProcess = true)>]
type SetPIPoint =  
    class
        inherit OSICmdletBaseWithConnection
    end

The SetPIPoint type exposes the following members.

Constructors

	Name	Description
	SetPIPoint

Properties

	Name	Description
	Attributes	The attributes to set on the existing PI Point. Use Get-Help Set-PIPoint -Examples to see usage.
	Connection	Specifies which connection to a PI Data Archive to use. (Overrides OSICmdletBaseWithConnectionConnection.)
	ID	ID of the pre-existing PI Point to edit.
	Name	Name of the pre-existing PI Point to edit.
	PIPoint	Pre-existing PI Point to edit.

Examples

Set-PIPoint -Name BoilerTemp1 -Attributes @{zero="50";span="100";displaydigits="-7"} -Connection $con

This example will edit the PI Point configuration for a pre-existing tag named "BoilerTemp1" by setting the attributes specified by the -Attributes hashtable.

Examples

Set-PIPoint -ID 16 -Attributes @{zero="50";span="100";displaydigits="-7"} -Connection $con

This example will edit the PI Point configuration for a pre-existing tag with ID 16 by setting the attributes specified by the -Attributes hashtable.

Examples

$piPoint | Set-PIPoint -Attributes @{zero="50";span="100";displaydigits="-7"}

Where:

$piPoint = Get-PIPoint -Name Sinusoid -Connection $conn

This example will edit the PI Point configuration for a pre-existing tag with ID 16 by setting the attributes specified by the -Attributes hashtable.

Examples

Set-PIPoint -Name BoilerTemp1 -Attributes @{ptsecurity="piadmin: A(r,w) | piadmins: A(r,w) | PIEngineers: A(r) | PIWorld: A(r)";datasecurity="piadmin: A(r,w) | piadmins: A(r,w) | PIEngineers: A(r) | PIWorld: A(r)"} -Connection $con

This example will set the point and data security strings for the "BoilerTemp1" PI Point. Note that this operation will not append security strings, but instead overwrite any security settings previously set.

PI Powershell