PI Powershell

RemoveAFSecurityIdentity Class

Save PDF

TABLE OF CONTENTS

RemoveAFSecurityIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Removes an existing AF Security Identity from an AF Server

The Remove-AFSecurityIdentity cmdlet removes an existing AF Security Identity from an AF Server. This cmdlet returns $true if the AF Identity was successfully removed and $false if there was a failure in removing the AF Identity.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemoveAFSecurityIdentity

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

Syntax

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

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

Dim instance As RemoveAFSecurityIdentity

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

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

The RemoveAFSecurityIdentity type exposes the following members.

Constructors

	Name	Description
	RemoveAFSecurityIdentity

Properties

	Name	Description
	AFSecurityIdentity	AF Security Identity to delete
	AFServer	AF Server from which to remove the AF Security Identity
	CheckIn	Check in changes immediately
	ID	GUID of the AF Security Identity to delete
	Name	Name of the AF Security Identity to delete

Examples

Remove-AFSecurityIdentity -Name "Engineers" -CheckIn -AFServer (Get-AFServer -Name PIAF1)

Removes the existing AF Security Identity "Engineers" from the AF Server "PIAF1". The change is checked in immediately.

Examples

Remove-AFSecurityIdentity -AFSecurityIdentity $EngineersIdentity -CheckIn

Where:

$EngineersIdentity = Get-AFSecurityIdentity -Name "Engineers" -Refresh -AFServer (Get-AFServer -Name "PIAF1")

Removes the existing AF Security Identity "Engineers" from the AF Server "PIAF1". The change is checked in immediately.

PI Powershell