PI Powershell

RemoveAFDatabase Class

Save PDF

TABLE OF CONTENTS

RemoveAFDatabase Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Removes an AF Database

The Remove-AFDatabase cmdlet will remove an AF Database on a specified AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemoveAFDatabase

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

Syntax

[CmdletAttribute("Remove", "AFDatabase", DefaultParameterSetName = "Database", 
	SupportsShouldProcess = true)]
public class RemoveAFDatabase : OSICmdletBase

<CmdletAttribute("Remove", "AFDatabase", DefaultParameterSetName := "Database", 
	SupportsShouldProcess := true)>
Public Class RemoveAFDatabase
	Inherits OSICmdletBase

Dim instance As RemoveAFDatabase

[CmdletAttribute(L"Remove", L"AFDatabase", DefaultParameterSetName = L"Database", 
	SupportsShouldProcess = true)]
public ref class RemoveAFDatabase : public OSICmdletBase

[<CmdletAttribute("Remove", "AFDatabase", DefaultParameterSetName = "Database", 
	SupportsShouldProcess = true)>]
type RemoveAFDatabase =  
    class
        inherit OSICmdletBase
    end

The RemoveAFDatabase type exposes the following members.

Constructors

	Name	Description
	RemoveAFDatabase

Properties

	Name	Description
	AFDatabase	AFDatabase object representing the AF Database to remove
	AFServer	AFServer object representing the AF Server from which to remove an AF Database
	ID	GUID of the AF Database to remove from the specified AF Server
	Name	Name of the AF Database to remove from the specified AF Server

Examples

Remove-AFDatabase -AFDatabase $afDB

Where:

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

This example will remove the AF Database "MyAFDB" from AF Server "PIAF1" by passing the AFDatabase object to Remove-AFDatabase

Examples

Remove-AFDatabase -Name MyAFDB -AFServer (Get-AFServer -Name "PIAF1")

This example will remove the AF Database "MyAFDB" from the AF Server "PIAF1".

PI Powershell