PI Powershell

GetPIPoint Class

Save PDF

TABLE OF CONTENTS

GetPIPoint Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

GetPIPoint Class

Gets PI Point(s) from a PI Data Archive

The Get-PIPoint cmdlet will search and get PI Points from the specified PI Data Archive. If getting PI Points by name, wildcards are supported. If getting PI Points using a WhereClause, wildcards are supported on an attribute by attribute basis.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = "ByNameAllAttributes")]
public class GetPIPoint : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIPoint", SupportsShouldProcess := true, 
	DefaultParameterSetName := "ByNameAllAttributes")>
Public Class GetPIPoint
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIPoint

[CmdletAttribute(L"Get", L"PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = L"ByNameAllAttributes")]
public ref class GetPIPoint : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIPoint", SupportsShouldProcess = true, 
	DefaultParameterSetName = "ByNameAllAttributes")>]
type GetPIPoint =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIPoint type exposes the following members.

Constructors

	Name	Description
	GetPIPoint

Properties

	Name	Description
	AllAttributes	Retrieve all PI Point attributes. If not specified then no attributes are retrieved.
	Attributes	The Attributes of the PI Point to retrieve. If not specified, no attributes are retrieved.
	Connection	Specifies which connection to a PI Data Archive to use. (Overrides OSICmdletBaseWithConnectionConnection.)
	ID	The ID of the PI Point(s) to get.
	Name	The mask of the PI Point(s) to get.
	WhereClause	WhereClause used to filter PI Points returned. The format of the WhereClause is Attribute:[Operator][Value] For example: Tag:=Sinusoid Multiple comparisons can be specified, separated by spaces. The following operators are supported: Equals: = Not equals: != or <> Greater than: > Greater than or equal to >= Less than: < Less than or equal to: <= If the Operator is omitted, equals is assumed.

Examples

$pipoints = Get-PIPoint -Name Sinu* -Attributes tag,recono,pointid,pointsource,ptsecurity,datasecurity -Connection $con

This example returns the tag name, record number, point ID, point source, point security ACL, and data security ACL for all tags whose name begins with "sinu". Note that wildcard searches are supported in this cmdlet. If you want to return all of the tag attributes, use the switch -AllAttributes instead of -Attributes.

Examples

$pipoints = Get-PIPoint -WhereClause "pointsource:=OPC" -AllAttributes -Connection $con

This example will get all points that have a pointsource = "OPC" with all attributes included.

Examples

$pipoints = Get-PIPoint -WhereClause "creationdate:>1-Jun-2017" -Connection $con

This example will get all points created on the PI Data Archive since June 1, 2017.

Examples

$pipoints = Get-PIPoint -WhereClause "creationdate:>1-Jun-2017 pointsource:=OPC" -Connection $con

This example combines the previous two examples and gets the PI Points with pointsource OPC that were created since June 1, 2017. The conditions are "and" conditions.

PI Powershell