PI Powershell

SetPIPointSource Class

Save PDF

TABLE OF CONTENTS

SetPIPointSource Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Set a PI PointSource

The Set-PIPointSource cmdlet edits an existing PI Point Source from a PI Data Archive. This cmdlet can add/edit the description of a Point Source.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Set", "PIPointSource", SupportsShouldProcess = true)]
public class SetPIPointSource : OSICmdletBaseWithConnection

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

Dim instance As SetPIPointSource

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

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

The SetPIPointSource type exposes the following members.

Constructors

	Name	Description
	SetPIPointSource

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use (Overrides OSICmdletBaseWithConnectionConnection.)
	Description	Description to set on the PI PointSource
	Name	Name of the PI PointSource to edit

Examples

Set-PIPointSource -Name "PItoPI_Corp" -Description "PItoPI tags coming from Corporate PI Server"  -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Sets the description for the PointSource "OPC" on the "PISRV1" PI Data Archive server.

PI Powershell