PI Powershell

RemoveAFCategory Class

Save PDF

RemoveAFCategory Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Remove an AF Category

The Remove-AFCategory cmdlet deletes an existing AF Category. The category can be an attribute, element, analysis, table or reference type category.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemoveAFCategory

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Remove", "AFCategory", SupportsShouldProcess = true)]
public class RemoveAFCategory : OSICmdletBase

<CmdletAttribute("Remove", "AFCategory", SupportsShouldProcess := true)>
Public Class RemoveAFCategory
	Inherits OSICmdletBase

Dim instance As RemoveAFCategory

[CmdletAttribute(L"Remove", L"AFCategory", SupportsShouldProcess = true)]
public ref class RemoveAFCategory : public OSICmdletBase

[<CmdletAttribute("Remove", "AFCategory", SupportsShouldProcess = true)>]
type RemoveAFCategory =  
    class
        inherit OSICmdletBase
    end

The RemoveAFCategory type exposes the following members.

Constructors

	Name	Description
	RemoveAFCategory

Properties

	Name	Description
	AFCategory	AF Category to remove
	AFDatabase	AF Database from which to remove the AF Category
	Analysis	Remove from Analysis Categories
	Attribute	Remove from Attribute Categories
	CheckIn	Check in changes immediately
	Element	Remove from Element Categories
	ID	ID of the AF Category to remove
	Name	Name of the AF Category to remove
	ReferenceType	Remove from ReferenceType Categories
	Table	Remove from Table Categories

Examples

Remove-AFCategory -Name "Product A Manufacturing" -Element -AFDatabase $afDB

Where:

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

Deletes an existing AF Element Category "Product A Manufacturing" from the AF Database "AFDatabase1" on AF Server "PIAF1".

Examples

Remove-AFCategory -Name "KPIs" -Attribute -AFDatabase $afDB

Where:

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

Deletes an existing AF Attribute Category "KPIs" from the AF Database "AFDatabase1" on AF Server "PIAF1".

Examples

Remove-AFCategory -AFCategory $afCategory -AFDatabase $afDB

Where:

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

$afCategory = Get-AFCategory -Name "Delete this Category" -Element -AFDatabase $afDB

Deletes an existing AF Element Category "Delete this Category" from the AF Database "AFDatabase1" on AF Server "PIAF1".

PI Powershell