PI Powershell

AddPIPoint Class

Save PDF

TABLE OF CONTENTS

AddPIPoint Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

AddPIPoint Class

Add a PI Point or PI Points

The Add-PIPoint cmdlet creates a PI Point on the specified PI Data Archive with the specified attributes.

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Add", "PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = "SinglePoint")]
public class AddPIPoint : OSICmdletBaseWithConnection

<CmdletAttribute("Add", "PIPoint", SupportsShouldProcess := true, 
	DefaultParameterSetName := "SinglePoint")>
Public Class AddPIPoint
	Inherits OSICmdletBaseWithConnection

Dim instance As AddPIPoint

[CmdletAttribute(L"Add", L"PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = L"SinglePoint")]
public ref class AddPIPoint : public OSICmdletBaseWithConnection

[<CmdletAttribute("Add", "PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = "SinglePoint")>]
type AddPIPoint =  
    class
        inherit OSICmdletBaseWithConnection
    end

The AddPIPoint type exposes the following members.

Constructors

	Name	Description
	AddPIPoint

Properties

	Name	Description
	Attributes	Attributes of PI Point or PI Points to use when creating. These are stored in an Attribute/Value pair.
	Connection	Specifies which connection to a PI Data Archive to use. (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI Point to create
	NameAndAttributesSets	Name and attributes for each PI Point being added. The hashtable entry names are the PI Point name, and the hashtable value is another hashtable with all attribute names and values to use when creating the PI Point. Use Get-Help Add-PIPoint -Examples to see example usage.
	Names	Names of the PI Points to create

Examples

Add-PIPoint -Name DefaultTag -Connection $con

This example will create a PI Point called "DefaultTag" on the server specified in the $con variable with all default PI Point attributes.

Examples

Add-PIPoint -Name BoilerTemp -Attributes @{Description="Boiler Temperature";PointSource="OPC";Location1="1";Location4="1"} -Connection $con

This example will create a single PI Point called "BoilerTemp" on the server specified in the $con variable with the attributes specified in the -Attributes hash table.

Examples

Add-PIPoint -Names BoilerTemp1,BoilerTemp2 -Attributes @{Description="Boiler Temperature";PointSource="OPC";Location1="1";Location4="1"} -Connection $con

This example will create a two PI Points: BoilerTemp1 and BoilerTemp2 with the same set of attributes as specified by the hashtable.

Examples

Add-PIPoint -NameAndAttributesSets @{"BoilerTemp1"=@{Description="Boiler 1 Temperature";PointSource="OPC";InstrumentTag="Boiler.1.Temp"};"BoilerTemp2"=@{Description="Boiler 2 Temperature";pointsource="OPC";InstrumentTag="Boiler.2.Temp"}} -Connection $con

This example will create a two PI Points: BoilerTemp1 and BoilerTemp2 with specified attributes per point.

The name of each hashtable entry is the name of the PI Point to create and the value is another hashtable containing the attributes with which to create the point.

PI Powershell