PI Powershell

GetAFElementTemplate Class

Save PDF

TABLE OF CONTENTS

GetAFElementTemplate Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get an AF Element Template

The Get-AFElementTemplate cmdlet gets an existing AF Element Template.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFElementTemplate

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

Syntax

[CmdletAttribute("Get", "AFElementTemplate", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)]
public class GetAFElementTemplate : OSICmdletBase

<CmdletAttribute("Get", "AFElementTemplate", DefaultParameterSetName := "Name", 
	SupportsShouldProcess := true)>
Public Class GetAFElementTemplate
	Inherits OSICmdletBase

Dim instance As GetAFElementTemplate

[CmdletAttribute(L"Get", L"AFElementTemplate", DefaultParameterSetName = L"Name", 
	SupportsShouldProcess = true)]
public ref class GetAFElementTemplate : public OSICmdletBase

[<CmdletAttribute("Get", "AFElementTemplate", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)>]
type GetAFElementTemplate =  
    class
        inherit OSICmdletBase
    end

The GetAFElementTemplate type exposes the following members.

Constructors

	Name	Description
	GetAFElementTemplate

Properties

	Name	Description
	AFDatabase	AFDatabase from which to get the AF Element Template
	ID	ID of the AF Element Template to get
	Index	Index of the AF Element Template to get
	Name	Name of the AF Element Template to get
	Refresh	Refresh container before accessing

Examples

Get-AFElementTemplate -Name "Boiler" -AFDatabase $afDB

Where:

$afDB = Get-AFDatabase "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

Gets the element template "Boiler" on the database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFElementTemplate -Name * -AFDatabase $afDB

Where:

$afDB = Get-AFDatabase "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

Gets all AF element templates on the database "AFDatabase1" on the AF Server "PIAF1".

PI Powershell