PI Powershell

RemoveAFElementTempalte Class

Save PDF

TABLE OF CONTENTS

RemoveAFElementTempalte Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove an AF Element Template

The Remove-AFElementTemplate cmdlet deletes an existing AF Element Template.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemoveAFElementTempalte

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

Syntax

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

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

Dim instance As RemoveAFElementTempalte

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

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

The RemoveAFElementTempalte type exposes the following members.

Constructors

	Name	Description
	RemoveAFElementTempalte

Properties

	Name	Description
	AFDatabase	AF Database from which to remove the AF Element Template
	AFElementTemplate	AF Element Template to remove
	CheckIn	Check in changes immediately
	ID	ID of the AF Element Template to remove
	Name	Name of the AF Element Template to remove

Examples

Remove-AFElementTemplate -Name "Boiler" -AFDatabase $afDB -CheckIn

Where:

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

Deletes the element template "Boiler" on the database "AFDatabase1" on the AF Server "PIAF1". The change is checked in immediately.

Examples

Remove-AFElementTemplate -AFElementTemplate $afEleTemplate -CheckIn

Where:

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

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

Deletes the AF element template "Boiler" on the database "AFDatabase1" on the AF Server "PIAF1". The change is checked in immediately.

Examples

Remove-AFElementTemplate -Name "*" -AFDatabase $afDB -CheckIn

Where:

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

Deletes all element templates on the database "AFDatabase1" on the AF Server "PIAF1". The change is checked in immediately.

PI Powershell